redirectr 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 39a819683a6431c465429c1c8cc26ca69025baf7de9733127ba09c3c871362ef
-  data.tar.gz: e9367fbb4d37863273194b4704f32632689420b7c8118240557f6344290ee71a
+  metadata.gz: aab12433022382d5fc61e4964d815430d39cf08aec7b6bbc32672065fdf7d115
+  data.tar.gz: 54b286ec8bc69898564184f1d2488189b3523f0da279d8d61b0ac3cd7444176a
 SHA512:
-  metadata.gz: 19cd53b6e4899399ef7a2f3e2a41c138e4b97fc7b981307d2c947422c2f1a739ec8fe39a4d6792597f040901110aad40fbf095622da45ccb245d6a90e577f3b2
-  data.tar.gz: ec84882c583f6c1e2d585f44b489838009633bf2521847f5c3540bf4f8ef705499e97aaeec55ebef1c71143cf8cf92e021598ad5a40292a0381ea15b38bad606
+  metadata.gz: 96332b3a061883e9b49881d74d1a54475f2850f4b9952404c5bf7bc2e478fc698c3e0097b5ea2cc53075274632249f34d80e390b2692ff95936c309065c04eb1
+  data.tar.gz: 582e0f5a9a7175068924b6d5dec1d7ef2044b14b6c935861d35dc555302cfd461317425ea69e913fa92c46be903d185753e2f925fe2130247da156008c8cba25

data/README.md

@@ -123,6 +123,9 @@ By default, Redirectr checks the protocol, hostname and port of the referrer aga
 
 Instead of using a URL in the referrer token, redirectr can act as an URL shortener that maps random tokens to URLs. This requires a storage_implementation to be defined:
 
+
+    require 'redirectr/referrer_token/active_record_storage'
+
     YourApp::Application.configure do
       config.x.redirectr.use_referrer_token = true
       config.x.redirectr.reuse_tokens = true # set to false to generate a new token for each and every link
@@ -145,13 +148,6 @@ Thanks so far to:
 * Falk Hoppe for Rails 2.3.x interoperability
 * Dimitar Haralanov for Rails 3.0.x interoperability
 * Raffael Schmid for spotting a typo in the gemspec description ;)
-
-## Changelog
-
-* 1.0.0: Validate Redirect urls against whitelist; Allow Token instead of URL referrer param
-* 0.1.1: deprecate *_path methods; improve Rails 5 compatibility by removing `alias` in view helpers
-* 0.1.0: Use absolute URI instead of path in current_path method
-* 0.0.8: Use ActiveSupport::Concern (Thanks to Dimitar Haralanov)
-* 0.0.7: Add Rails 3.0 compatibility (Thanks to Falk Hoppe)
+* Till Schulte-Coerne for removing implicit dependencies and cleaning up unused code
 
 Copyright (c) 2010 Willem van Kerkhof <wvk@consolving.de>, released under the MIT license

data/lib/redirectr/referrer_token/active_record_storage.rb

@@ -0,0 +1,28 @@
+module Redirectr
+  class ReferrerToken
+
+    # this is a stora implementation for activerecord-
+    class ActiveRecordStorage < ActiveRecord::Base
+      validates_presence_of :url, :token
+
+      self.table_name = :redirectr_referrer_tokens
+
+      class << self
+        def store(record)
+          self.find_or_create_by url: record.url, token: record.token
+          record.url
+        end
+
+        def fetch(token)
+          url = self.find_by(token: token)&.url
+          ReferrerToken(url) if url
+        end
+
+        def token_for_url(url)
+          self.find_by(url: url)&.token
+        end
+      end
+    end
+
+  end
+end

data/lib/redirectr/referrer_token/global_var_storage.rb

@@ -0,0 +1,26 @@
+module Redirectr
+  class ReferrerToken
+
+    class GlobalVarStorage
+
+      def persisted?
+        false
+      end
+
+      class << self
+        def store(record)
+          $referrer_lookup[record.token] = record.url
+        end
+
+        def fetch(token)
+          ReferrerToken($referrer_lookup[token])
+        end
+
+        def token_for_url(url)
+          $referrer_lookup.key(url)
+        end
+      end
+    end
+
+  end
+end

data/lib/redirectr/referrer_token.rb

@@ -0,0 +1,73 @@
+require 'active_model'
+
+module Redirectr
+  class ReferrerToken
+
+    extend ActiveModel::Naming
+
+    attr_reader :url, :token
+
+    def initialize(url, token=nil)
+      @url   = url
+      @token = token
+
+      if Redirectr.config.use_referrer_token
+        if Redirectr.config.storage_implementation.nil?
+          raise "Missing storage implementation for referrer tokens! please define config.x.redirectr.storage_implementation"
+        end
+
+        if Redirectr.config.reuse_tokens
+          @token ||= Redirectr.config.storage_implementation.token_for_url(url)
+        end
+        @token ||= SecureRandom.hex(16)
+      elsif Redirectr.config.encrypt_referrer
+        @token ||= self.class.cryptr.encrypt_and_sign url
+      else
+        @token ||= url
+      end
+    end
+
+    def to_param
+      @token
+    end
+
+    def to_model
+      self
+    end
+
+    def to_s
+      @url
+    end
+
+    def persisted?
+      true
+    end
+
+    def save
+      if Redirectr.config.use_referrer_token
+        Redirectr.config.storage_implementation.store self
+      end
+    end
+
+    def self.from_param(param)
+      if Redirectr.config.encrypt_referrer
+        ReferrerToken.new self.class.cryptr.decrypt_and_verify param
+      elsif Redirectr.config.use_referrer_token
+        self.lookup(param)
+      else
+        ReferrerToken.new param
+      end
+    end
+
+    def self.lookup(token)
+      Redirectr.config.storage_implementation.fetch token
+    end
+
+    private
+
+    def self.cryptr
+      @cryptr ||= ActiveSupport::MessageEncryptor.new(Rails.application.secrets.secret_key_base)
+    end
+
+  end
+end

data/lib/redirectr/version.rb

@@ -1,3 +1,3 @@
 module Redirectr
-  VERSION = '1.0.2'
+  VERSION = '1.0.3'
 end

data/lib/redirectr.rb

@@ -1,6 +1,8 @@
-require 'redirectr/engine'
 require 'securerandom'
 
+require 'redirectr/engine'
+require 'redirectr/referrer_token'
+
 def ReferrerToken(url, token=nil)
   case url
   when Redirectr::ReferrerToken
@@ -30,120 +32,6 @@ module Redirectr
     Rails.configuration.x.redirectr
   end
 
-  class ReferrerToken
-    extend ActiveModel::Naming
-
-    # this is a stora implementation for activerecord-
-    class ActiveRecordStorage < ActiveRecord::Base
-      validates_presence_of :url, :token
-
-      self.table_name = :redirectr_referrer_tokens
-
-      class << self
-        def store(record)
-          self.find_or_create_by url: record.url, token: record.token
-          record.url
-        end
-
-        def fetch(token)
-          url = self.find_by(token: token)&.url
-          ReferrerToken(url) if url
-        end
-
-        def token_for_url(url)
-          self.find_by(url: url)&.token
-        end
-      end
-    end
-
-    class GlobalVarStorage
-      extend ActiveModel::Naming
-
-      def persisted?
-        false
-      end
-
-      class << self
-        def store(record)
-          $referrer_lookup[record.token] = record.url
-        end
-
-        def fetch(token)
-          ReferrerToken($referrer_lookup[token])
-        end
-
-        def token_for_url(url)
-          $referrer_lookup.key(url)
-        end
-      end
-    end
-
-    attr_reader :url, :token
-
-    def initialize(url, token=nil)
-      @url   = url
-      @token = token
-
-      if Redirectr.config.use_referrer_token
-        if Redirectr.config.storage_implementation.nil?
-          raise "Missing storage implementation for referrer tokens! please define config.x.redirectr.storage_implementation"
-        end
-
-        if Redirectr.config.reuse_tokens
-          @token ||= Redirectr.config.storage_implementation.token_for_url(url)
-        end
-        @token ||= SecureRandom.hex(16)
-      elsif Redirectr.config.encrypt_referrer
-        @token ||= self.class.cryptr.encrypt_and_sign url
-      else
-        @token ||= url
-      end
-    end
-
-    def to_param
-      @token
-    end
-
-    def to_model
-      self
-    end
-
-    def to_s
-      @url
-    end
-
-    def persisted?
-      true
-    end
-
-    def save
-      if Redirectr.config.use_referrer_token
-        Redirectr.config.storage_implementation.store self
-      end
-    end
-
-    def self.from_param(param)
-      if Redirectr.config.encrypt_referrer
-        ReferrerToken.new self.class.cryptr.decrypt_and_verify param
-      elsif Redirectr.config.use_referrer_token
-        self.lookup(param)
-      else
-        ReferrerToken.new param
-      end
-    end
-
-    def self.lookup(token)
-      Redirectr.config.storage_implementation.fetch token
-    end
-
-    private
-
-    def self.cryptr
-      @cryptr ||= ActiveSupport::MessageEncryptor.new(Rails.application.secrets.secret_key_base)
-    end
-  end
-
-
   module ControllerMethods
     extend ActiveSupport::Concern
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redirectr
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Willem van Kerkhof
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-13 00:00:00.000000000 Z
+date: 2023-02-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -49,25 +49,21 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/config/redirectr_manifest.js
-- app/assets/javascripts/redirectr/application.js
-- app/assets/stylesheets/redirectr/application.css
-- app/controllers/redirectr/application_controller.rb
 - app/helpers/redirectr/application_helper.rb
-- app/jobs/redirectr/application_job.rb
-- app/models/redirectr/application_record.rb
-- app/views/layouts/redirectr/application.html.erb
 - config/routes.rb
 - db/migrate/20201120110532_create_redirectr_referrer_tokens.rb
 - lib/redirectr.rb
 - lib/redirectr/engine.rb
+- lib/redirectr/referrer_token.rb
+- lib/redirectr/referrer_token/active_record_storage.rb
+- lib/redirectr/referrer_token/global_var_storage.rb
 - lib/redirectr/version.rb
 - lib/tasks/redirectr_tasks.rake
 homepage: http://github.com/wvk/redirectr
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -82,8 +78,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.27
-signing_key: 
+rubygems_version: 3.3.15
+signing_key:
 specification_version: 4
 summary: Rails referrer-URL handling done right
 test_files: []

data/app/assets/config/redirectr_manifest.js

@@ -1,2 +0,0 @@
-//= link_directory ../javascripts/redirectr .js
-//= link_directory ../stylesheets/redirectr .css

data/app/assets/javascripts/redirectr/application.js

@@ -1,13 +0,0 @@
-// This is a manifest file that'll be compiled into application.js, which will include all the files
-// listed below.
-//
-// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
-// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
-//
-// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file. JavaScript code in this file should be added after the last require_* statement.
-//
-// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
-// about supported directives.
-//
-//= require_tree .

data/app/assets/stylesheets/redirectr/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/app/controllers/redirectr/application_controller.rb

@@ -1,5 +0,0 @@
-module Redirectr
-  class ApplicationController < ActionController::Base
-    protect_from_forgery with: :exception
-  end
-end

data/app/jobs/redirectr/application_job.rb

@@ -1,4 +0,0 @@
-module Redirectr
-  class ApplicationJob < ActiveJob::Base
-  end
-end

data/app/models/redirectr/application_record.rb

@@ -1,5 +0,0 @@
-module Redirectr
-  class ApplicationRecord < ActiveRecord::Base
-    self.abstract_class = true
-  end
-end

data/app/views/layouts/redirectr/application.html.erb

@@ -1,16 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-  <title>Redirectr</title>
-  <%= csrf_meta_tags %>
-  <%= csp_meta_tag %>
-
-  <%= stylesheet_link_tag    "redirectr/application", media: "all" %>
-  <%= javascript_include_tag "redirectr/application" %>
-</head>
-<body>
-
-<%= yield %>
-
-</body>
-</html>