https://github.com/yosefbennywidyo/short_io
A Ruby gem to use with short.io
https://github.com/yosefbennywidyo/short_io
gems ruby
Last synced: 5 months ago
JSON representation
A Ruby gem to use with short.io
- Host: GitHub
- URL: https://github.com/yosefbennywidyo/short_io
- Owner: yosefbennywidyo
- License: mit
- Created: 2022-01-25T07:58:03.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-14T15:27:22.000Z (almost 2 years ago)
- Last Synced: 2025-12-13T04:01:46.405Z (7 months ago)
- Topics: gems, ruby
- Language: Ruby
- Homepage: https://rubygems.org/gems/short_io
- Size: 38.1 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# ShortIo
[](https://badge.fury.io/rb/short_io) | [](https://app.travis-ci.com/yosefbennywidyo/short_io) | [](https://codecov.io/gh/yosefbennywidyo/short_io)
A Ruby gem to use with [short.io](https://short.io)
[ShortIo gem documentation](https://rubydoc.info/gems/short_io)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'short_io'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install short_io
## Usage
```ruby
require 'short_io'
ShortIo::ShortUrl.new('kreasi-guna-semesta.co.id', 'API_KEY')
```
### Add Domain
```ruby
ShortIo::ShortUrl.new('kreasi-guna-semesta.co.id', 'API_KEY').add_domain
```
### List Domain
```ruby
ShortIo::ShortUrl.new('kreasi-guna-semesta.co.id', 'API_KEY').domain_list
```
### Update Domain
```ruby
ShortIo::ShortUrl.new('example.com', 'YOUR_API_KEY', {domain_id: YOUR_DOMAIN_ID, root_redirect_url: 'YOUR_LINK'}).update_domain
```
### Delete Domain
```ruby
ShortIo::ShortUrl.new('example.com', 'YOUR_API_KEY', {domain_id: YOUR_DOMAIN_ID}).delete_domain
```
## 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/yosefbennywidyo/short_io. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/yosefbennywidyo/short_io/blob/main/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the ShortIoShortBrandedUrl project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/yosefbennywidyo/short_io/blob/main/CODE_OF_CONDUCT.md).