https://github.com/toshimaru/ruby-short_url
Ruby implementation of python-short_url.
https://github.com/toshimaru/ruby-short_url
gem ruby
Last synced: 9 months ago
JSON representation
Ruby implementation of python-short_url.
- Host: GitHub
- URL: https://github.com/toshimaru/ruby-short_url
- Owner: toshimaru
- License: mit
- Created: 2015-05-09T13:53:48.000Z (about 11 years ago)
- Default Branch: main
- Last Pushed: 2022-12-04T07:36:35.000Z (over 3 years ago)
- Last Synced: 2025-09-27T19:55:40.466Z (9 months ago)
- Topics: gem, ruby
- Language: Ruby
- Homepage:
- Size: 35.2 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ruby::ShortUrl
[](http://badge.fury.io/rb/ruby-short_url)
[](https://codeclimate.com/github/toshimaru/ruby-short_url/coverage)
[](https://codeclimate.com/github/toshimaru/ruby-short_url)
## Description
Ruby implementation for generating Tiny URL. The implementation is based on [python-short_url](https://github.com/Alir3z4/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.
>
> The URL alphabet is fully customizable and may contain any number of characters.
> The intended use is that incrementing, consecutive integers will be used as keys to generate the short URLs. For example, when creating a new URL, the unique integer ID assigned by a database could be used to generate the URL by using this module. Or a simple counter may be used. As long as the same integer is not used twice, the same short URL will not be generated twice.
More detail is [here](https://github.com/Alir3z4/python-short_url#short-url-generator).
## Installation
Add this line to your application's `Gemfile`:
```ruby
gem 'ruby-short_url'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install ruby-short_url
## Usage
```rb
# shorten id
Ruby::ShortUrl::Encoder.new.encode_url(123456) # => "00crI"
# decode encoded
Ruby::ShortUrl::Encoder.new.decode_url("00crI") # => 123456
```
### Create your own URL Shortner
```rb
class CustomEncoder < Ruby::ShortUrl::Encoder
def initialize
# Set your own custom alphabet and block_size
super(alphabet: "0123abc", block_size: 5)
end
end
```
```rb
# > custom_encoder = CustomEncoder.new
# => #
#
# > custom_encoder.encode_url(1)
# => "00022"
# > custom_encoder.encode_url(2)
# => "00011"
# > custom_encoder.encode_url(3)
# => "00033"
# > custom_encoder.encode_url(4)
# => "0000a"
#
# > custom_encoder.decode_url("00022")
# => 1
# > custom_encoder.decode_url("00011")
# => 2
# > custom_encoder.decode_url("00033")
# => 3
# > custom_encoder.decode_url("0000a")
# => 4
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also 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`.
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/toshimaru/ruby-short_url. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).