Git Product home page Git Product logo

sequel-hash_id's Introduction

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:

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.

plugin :hash_id, salt: "your-salt".freeze

Once you've done that, you can now access the following methods:

# 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 before attempting a pull request.

License

The gem is available as open source under the terms of the MIT License.

sequel-hash_id's People

Contributors

adam12 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.