Ruby::ShortUrl
Ruby implementation for generating Tiny URL. Ruby implementation of python-short_url
A bit-shuffling approach is used to avoid generating consecutive, predictable URLs. However, the algorithm is deterministic and will guarantee that no collisions will occur.
More detail is here.
Installation
Add this line to your application's Gemfile
:
gem 'ruby-short_url'
And then execute:
$ bundle
Or install it yourself as:
$ gem install ruby-short_url
Usage
# shorten id
Ruby::ShortUrl::Encoder.new.encode_url(123456) # => "00crI"
# decode encoded
Ruby::ShortUrl::Encoder.new.decode_url("00crI") # => 123456
Create your own short URL
class CustomEncoder < Ruby::ShortUrl::Encoder
def initialize
# Set your own custom alphabet and block_size
super(alphabet: "0123abc", block_size: 5)
end
end
# > custom_encoder = CustomEncoder.new
# => #<CustomEncoder:0x007faf3babc830 @alphabet="0123abc", @block_size=5, @mask=31, @mapping=[0, 1, 2, 3, 4]>
#
# > custom_encoder.encode_url(1)
# => "00022"
# > custom_encoder.encode_url(2)
# => "00011"
# > custom_encoder.encode_url(3)
# => "00033"
#
# > custom_encoder.decode_url("00022")
# => 1
# > custom_encoder.decode_url("00011")
# => 2
# > custom_encoder.decode_url("00033")
# => 3
Development
After checking out the repo, run bin/setup
to install dependencies. Then, run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
to create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
- Fork it ( https://github.com/[my-github-username]/ruby-short_url/fork )
- Create your feature branch (
git checkout -b my-new-feature
) - Commit your changes (
git commit -am 'Add some feature'
) - Push to the branch (
git push origin my-new-feature
) - Create a new Pull Request