Skip to content

yosefbennywidyo/short_io

Repository files navigation

ShortIo

Gem Version | Build Status | codecov

A Ruby gem to use with short.io

ShortIo gem documentation

Installation

Add this line to your application's Gemfile:

gem 'short_io'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install short_io

Usage

require 'short_io'

ShortIo::ShortUrl.new('kreasi-guna-semesta.co.id', 'API_KEY')

Add Domain

ShortIo::ShortUrl.new('kreasi-guna-semesta.co.id', 'API_KEY').add_domain

List Domain

ShortIo::ShortUrl.new('kreasi-guna-semesta.co.id', 'API_KEY').domain_list

Update Domain

ShortIo::ShortUrl.new('example.com', 'YOUR_API_KEY', {domain_id: YOUR_DOMAIN_ID, root_redirect_url: 'YOUR_LINK'}).update_domain

Delete Domain

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.

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.

License

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

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.