bullet_train-obfuscates_id 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2d5941b63ab2c4dd139fd34d6512419db25af0e5076bdcdd5eda10d88dbeff5a
+  data.tar.gz: 21c8d8eeb96366a9f6cade51ae7355358e5e72a283b55413cac52f33e50bb772
+SHA512:
+  metadata.gz: 5276bc3dd254c4886d60c8cde4f62163315575d519723fa2261c5d7b3a34488e714f1faaa91228a2d0654323a4edf5a1b3d7d3793ee709ed095bfad8a2843e7d
+  data.tar.gz: 8909c55a6d2857ad537b7dd53c20709a94085a194a37e41889c8a380a03a2e4062329afeb00db48d7d4e013d32991607d5d33281b5ddab1c42d6b7a87ef16262

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2022 Andrew Culver
+
+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/README.md

@@ -0,0 +1,28 @@
+# BulletTrain::ObfuscatesId
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "bullet_train-obfuscates_id"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install bullet_train-obfuscates_id
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/models/concerns/obfuscates_id.rb

@@ -0,0 +1,51 @@
+module ObfuscatesId
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def hashids
+      # ⚠️ Changing anything in this method will invalidate any URLs with obfuscated IDs that are in the wild.
+      # You should not change any of these settings after going live unless you're OK breaking links in sent emails,
+      # breaking bookmarks to pages within your application, etc. For this reason, we don't want the Hashids salt
+      # configurable via an ENV value.
+
+      # We don't include digits in our alphabet because it sometimes results in fully numeric strings being generated,
+      # and we can't differentiate those from normal IDs that we still need to be able to deal with.
+      @hashids ||= Hashids.new "Default ID Obfuscation Salt for #{name}", 6, "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
+    end
+
+    def encode_id(id)
+      hashids.encode(id)
+    end
+
+    def decode_id(id)
+      return id if id.to_i > 0
+      hashids.decode(id).first
+    end
+
+    def find(*ids)
+      super(*ids.map { |id| decode_id(id) })
+    end
+
+    def relation
+      super.tap { |r| r.extend ClassMethods }
+    end
+
+    def has_many(*args, &block)
+      options = args.extract_options!
+      options[:extend] = Array(options[:extend]).push(ClassMethods)
+      super(*args, **options, &block)
+    end
+
+    def find_by_obfuscated_id(id)
+      find_by(id: decode_id(id))
+    end
+  end
+
+  def obfuscated_id
+    @obfuscated_id ||= self.class.encode_id(id)
+  end
+
+  def to_param
+    obfuscated_id
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/bullet_train/obfuscates_id/engine.rb

@@ -0,0 +1,6 @@
+module BulletTrain
+  module ObfuscatesId
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/bullet_train/obfuscates_id/version.rb

@@ -0,0 +1,5 @@
+module BulletTrain
+  module ObfuscatesId
+    VERSION = "1.0.0"
+  end
+end

data/lib/bullet_train/obfuscates_id.rb

@@ -0,0 +1,8 @@
+require "bullet_train/obfuscates_id/version"
+require "bullet_train/obfuscates_id/engine"
+
+module BulletTrain
+  module ObfuscatesId
+    # Your code goes here...
+  end
+end

data/lib/tasks/bullet_train/obfuscates_id_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :bullet_train_obfuscates_id do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification
+name: bullet_train-obfuscates_id
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Andrew Culver
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+description: Bullet Train Obfuscates ID
+email:
+- andrew.culver@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/bullet_train_obfuscates_id_manifest.js
+- app/models/concerns/obfuscates_id.rb
+- config/routes.rb
+- lib/bullet_train/obfuscates_id.rb
+- lib/bullet_train/obfuscates_id/engine.rb
+- lib/bullet_train/obfuscates_id/version.rb
+- lib/tasks/bullet_train/obfuscates_id_tasks.rake
+homepage: https://github.com/bullet-train-co/bullet_train-obfuscates_id
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bullet-train-co/bullet_train-obfuscates_id
+  source_code_uri: https://github.com/bullet-train-co/bullet_train-obfuscates_id
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Bullet Train Obfuscates ID
+test_files: []