Project

relinkly

0.0
Low commit activity in last 3 years
relinklycdrrazan/relinklyHomepageDocumentationSource CodeWiki
Easily create short links on your ruby apps using Rebrandly API.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Popularity
Downloads
5,198
Stars
0
Forks
0
Watchers
0
 Releases
Current version
1.1.3
Total releases
8
First release
2020-12-30
Latest release
2025-01-14
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2021-02-28
Reverse Dependencies
0

 Dependencies

Development

bundler
~> 2.6.2
rake
~> 13.2.1
rspec
~> 3.13.0

Runtime

httparty
~> 0.22.0
json
~> 2.9.1
 Project Readme

relinkly Gem Version

Installation

Add this line to your application's Gemfile:

gem 'relinkly'

And then execute:

$ bundle

Or install it yourself as:

$ gem install relinkly

Usage

If using Rails, put the following into your application.rb. If just Ruby, run this before trying to use the API.

Relinkly.configure do |config|
  config.api_key = 'YOUR_KEY_HERE'
end

Instantiate an API object.

api = Relinkly::API.new

API Requests

Account, Workspaces & Domains

api.account                         # GET /v1/account
api.workspaces                      # GET /v1/workspaces
api.domains                         # GET /v1/domains
api.domain(id)                      # GET /v1/domains/:id
api.domain_count(options)           # GET /v1/domains/count

Links

api.links                           # GET /v1/links
api.link(id)                        # GET /v1/links/:id
api.link_count(options)             # GET /v1/links/count
api.new_link(options)               # GET /v1/links/new
api.shorten(destination, options)   # POST /v1/links
api.update_link(id, options)        # POST /v1/links/:id
api.delete_links(ids, options)      # DELETE /v1/links
api.delete_link(id, options)        # DELETE /v1/links/:id
api.tags_link(id, options)          # GET /v1/links/:id/tags
api.add_tag_link(id, options)       # POST /v1/links/:id/tags
api.delete_tag_link(id, options)    # DELETE /v1/links/:id/tags
api.scripts_link(id, options)       # GET /v1/links/:id/scripts
api.add_script_link(id, options)    # POST /v1/links/:id/scripts
api.delete_script_link(id, options) # DELETE /v1/links/:id/scripts

Tags

api.tags                           # GET /v1/tags
api.tag(id)                        # GET /v1/tags/:id
api.tag_count(options)             # GET /v1/tags/count
api.new_tag(options)               # POST /v1/tags
api.update_tag(id, options)        # POST /v1/tags/:id
api.delete_tag(id, options)        # DELETE /v1/tags/:id

Scripts

api.scripts                        # GET /v1/scripts
api.script(id)                     # GET /v1/scripts/:id
api.script_count(options)          # GET /v1/scripts/count

Creating your branded short link!

your_domain = api.domains.first
branded_link = api.shorten('https://google.com', domain: your_domain.to_h, title: 'Google', description: 'Google Homepage')

Workspace workaround

Please see the applicable methods for options available when making requests. You need to pass the workspace_id in the options as follows in case you want to select other than the default workspace.

Here's how you can achieve that:

your_domain = api.domains.first
your_workspace_id = api.workspaces.first.id
branded_link = api.shorten('https://google.com', domain: your_domain.to_h, title: 'Google', description: 'Google Homepage', workspace: your_workspace_id)

Please note that your_domain should already be included inside your_workspace.

You can find all the details about your workspace by going here. https://app.rebrandly.com/workspaces

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/cdrrazan/relinkly.

License

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