sequel-hash_id 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0fda23b727eff09bf0c2047993946945ba8999f
+  data.tar.gz: 9ee99e696a6960f612ce546ff3d46731b7724f02
+SHA512:
+  metadata.gz: 90cf852bcca48f78ecaffe374e91e54756e87f2592ef304a30f9c750610f417213aa1c91d7ca35350f29aa4b1a814ee5897331fba884503fe110d108231c95a0
+  data.tar.gz: ab19e431be943c905c83cf59582a6f1d28cc08b21df026529daf4fad7b4bbb54b9c2acbdcd56a24abb2182220484118fe8fda198cbba23529837e1bfc2b8568a

data/README.md

@@ -0,0 +1,64 @@
+# Sequel Hash ID
+
+Easily obfuscate your Integer-based primary keys in Sequel models. The anonymity
+of a UUID without any overhead.
+
+These are commonly used for URL shorteners, but they have other use cases as well.
+Specifically, they are very handy to prevent nieve crawling / scraping, where your
+records are known to be incremental.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "sequel-hash_id"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sequel-hash_id
+
+## Usage
+
+This plugin likely only makes sense at the Model level, so configure it
+for each model you want to have a hashid for. The only required option
+is the salt you wish to use.
+
+```ruby
+plugin :hash_id, salt: "your-salt".freeze
+```
+
+Once you've done that, you can now access the following methods:
+
+```ruby
+# Get the instance's hashid
+instance = YourModel.create
+instance.hashid
+
+# Lookup using a hashid
+YourModel.with_hashid("the-hashid")
+
+# Dataset lookup method
+YourModel.where { ... }.with_hashid("the-hashid")
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/adam12/sequel-hash_id.
+
+I love pull requests! If you fork this project and modify it, please ping me to see
+if your changes can be incorporated back into this project.
+
+That said, if your feature idea is nontrivial, you should probably open an issue to
+[discuss it](http://www.igvita.com/2011/12/19/dont-push-your-pull-requests/)
+before attempting a pull request.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/sequel/plugins/hash_id.rb

@@ -0,0 +1,58 @@
+require "forwardable"
+require "hashids"
+
+module Sequel::Plugins # :nodoc:
+# This plugin allows you to easily obscure the primary key of your models with
+# an encoded hashid equivalent.
+#
+# A few convenience methods are provided which wrap around the +Hashids+ library.
+#
+# = Plugin Options
+#
+# :salt :: The salt used to hash/unhash the primary key values. Required.
+# :length :: By default, the length is variable. Setting an integer here forces
+#            all hashids to be a specific length.
+module HashId
+  def self.apply(model, opts = {}) # :nodoc:
+    model.instance_eval do
+      @hash_id_state = {}
+    end
+  end
+
+  def self.configure(model, opts = {}) # :nodoc:
+    model.instance_eval do
+      @hash_id_state[:salt] = opts[:salt] || raise(ArgumentError, "hash_id plugin missing salt option")
+      @hash_id_state[:length] = opts[:length] || 0
+    end
+  end
+
+  module ClassMethods
+    Sequel::Plugins.def_dataset_methods(self, :with_hashid)
+
+    # The instance of +Hashids+ used to encode and decode values
+    def hasher
+      Hashids.new(@hash_id_state[:salt], @hash_id_state[:length])
+    end
+
+    # Lookup a record with a hashid, returning nil if none is found
+    def with_hashid(hashid)
+      id ,= hasher.decode(hashid)
+
+      self[id] if id
+    end
+  end
+
+  module InstanceMethods
+    # The hashid of the model instance
+    def hashid
+      self.class.hasher.encode(id) if id
+    end
+  end
+
+  module DatasetMethods
+    extend Forwardable
+
+    def_delegators :model, :with_hashid
+  end
+end
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: sequel-hash_id
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Adam Daniels
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: hashids
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rubygems-tasks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: 
+email: adam@mediadrive.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/sequel/plugins/hash_id.rb
+homepage: https://github.com/adam12/sequel-hash_id
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Easily obscure the primary key of your Sequel models
+test_files: []