relinkly 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62e19675647abf66a3224c35a5f6bd8f9f091e8364d09bfd31f7302a1a097652
-  data.tar.gz: 81604d5824117d10be52b756df585e08187e5613f7d788f9490f201a5bd76a39
+  metadata.gz: 65d72a34b49919ac9b5ba4ab0e832ef4e64a15c9876c90a6e7d71b9add7e213f
+  data.tar.gz: a81194a39f7995adab36df320ebd508a72adfc6d2e14fb416a6aae075a513b01
 SHA512:
-  metadata.gz: 881108d64d8453895389e51fc4dd2e7892ec3913659e47c88138d0d5f5c36a445557060611e371bc44b69d54ee1bc9875e880f23d5929dc292683be3d2df7520
-  data.tar.gz: 56330896dd5aa3b5de153c74fdc8e382ccd9ab8b505094ae0f48a886752f891a46c7af711f8c7fb2a68c5a160af2fcb9168e0b570b3e21cc4f9489c078e8a78d
+  metadata.gz: bddef48388d44413b2896894e8d16c8868a93479fb4e461969fe57b1c078bfbbeb4ea3d4eab1c320991c95fd7a3530e61c91d20d3a99ae849bdf5495f7e85cca
+  data.tar.gz: db3060d654fd2fbad01786e922200cf797f20db7f6c3470184e05c5837961cb20f3c67238d7909595a794b5b14d097437e04583cd307ab9cb396976986225c84

data/.gitignore

@@ -1,4 +1,3 @@
-
 /.bundle/
 /.yardoc
 /Gemfile.lock
@@ -9,3 +8,4 @@
 /spec/reports/
 /tmp/
 *.gem
+.idea

data/README.md

@@ -1,4 +1,4 @@
-# relinkly
+# relinkly [![Gem Version](https://badge.fury.io/rb/relinkly.svg)](https://badge.fury.io/rb/relinkly)
 
 ## Installation
 
@@ -57,7 +57,7 @@ api.delete_tag(id, options)        # DELETE /v1/tags/:id
 #### Links
 ```ruby
 api.links                           # GET /v1/links
-api.links(id)                       # GET /v1/links/:id
+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
@@ -66,7 +66,7 @@ api.delete_link(id, options)        # DELETE /v1/links/:id
 api.tags_link(id, options)          # GET /v1/links/:id/tags
 ```
 
-#### Make a new branded short link
+#### Creating your branded short link!
 
 ```ruby
 my_domain = api.domains.first
@@ -74,8 +74,9 @@ link = api.shorten('https://google.com', domain: my_domain.to_h, title: 'Google'
 ```
 
 #### Workspace workaround
-Please see the applicable methods for options available when making requests. In case of new link creation, default workspace is selected if workspace isn't mentioned explictly.
-Please pass the workspace_id in the options as follows in case you want to create branded link to another workspace.
+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 perform operations other than the default workspace. 
+
+Here's how you can create a link into another workspace. 
 
 ```ruby
 my_domain = api.domains.first
@@ -83,7 +84,9 @@ my_workspace_id = api.workspaces.first.id
 link = api.shorten('https://google.com', domain: my_domain.to_h, title: 'Google', description: 'Google Homepage', workspace: my_workspace_id)
 ```
 
-Please note that `my_domain` should already be included inside `my_workspace`. You can find all the details about your workspace by going here. https://app.rebrandly.com/workspaces
+Please note that `my_domain` should already be included inside `my_workspace`. Similarly other operations on link and tags can be achieved as above.
+
+You can find all the details about your workspace by going here. https://app.rebrandly.com/workspaces
 
 
 ## Contributing

data/bin/console

@@ -1,8 +1,8 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'relinkly'
+require "bundler/setup"
+require "relinkly"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -11,5 +11,5 @@ require 'relinkly'
 # require "pry"
 # Pry.start
 
-require 'irb'
+require "irb"
 IRB.start

data/lib/relinkly/api.rb

@@ -11,7 +11,13 @@ module Relinkly
     API_VERSION = 'v1'
     BASE_URL = "https://api.rebrandly.com/#{API_VERSION}"
 
+    ########################################
+    # ACCOUNT / WORKSPACES
+    ########################################
+    #
     # ACCOUNT ENDPOINTS
+    #
+    ########################################
 
     # GET /v1/account
     def account
@@ -19,17 +25,25 @@ module Relinkly
     end
 
     # WORKSPACES ENDPOINTS
+    #
+    ########################################
 
     # GET /v1/account/workspaces
-    def workspaces(options = {})
-      all_workspaces = relinkly_request(:get, 'account/workspaces', options)
+    def workspaces(options: {})
+      all_workspaces = relinkly_request(:get, 'workspaces', options)
       all_workspaces.map { |workspace| Workspace.new(workspace) }
     end
 
+    ########################################
+    # REBRANDLY OPS
+    ########################################
+    #
     # DOMAINS ENDPOINTS
+    #
+    ########################################
 
     # GET /v1/domains
-    def domains(options = {})
+    def domains(options: {})
       all_domains = relinkly_request(:get, 'domains', options)
       all_domains.map { |domain| Domain.new(domain) }
     end
@@ -40,14 +54,16 @@ module Relinkly
     end
 
     # GET /v1/domains/count
-    def domain_count(_options = {})
+    def domain_count(_options: {})
       relinkly_request(:get, 'domains/count')['count']
     end
 
     # TAGS ENDPOINTS
+    #
+    ########################################
 
     # GET /v1/tags
-    def tags(options = {})
+    def tags(options: {})
       all_tags = relinkly_request(:get, 'tags', options)
       all_tags.map { |tag| Tag.new(tag) }
     end
@@ -58,30 +74,32 @@ module Relinkly
     end
 
     # GET /v1/tags/count
-    def tag_count(_options = {})
+    def tag_count(_options: {})
       relinkly_request(:get, 'tags/count')['count']
     end
 
     # POST /v1/tags
-    def new_tag(destination, options = {})
+    def new_tag(destination, options: {})
       options[:destination] = destination
       Tag.new(relinkly_request(:post, 'tags', options))
     end
 
     # POST /v1/tags/:id
-    def update_tag(id, options = {})
+    def update_tag(id, options: {})
       Tag.new(relinkly_request(:post, "tags/#{id}", options))
     end
 
     # DELETE /v1/tags/:id
-    def delete_tag(id, options = {})
+    def delete_tag(id, options: {})
       Tag.new(relinkly_request(:delete, "tags/#{id}", options))
     end
 
     # LINKS ENDPOINTS
+    #
+    ########################################
 
     # GET /v1/links
-    def links(options = {})
+    def links(options: {})
       all_links = relinkly_request(:get, 'links', options)
       all_links.map { |link| Link.new(link) }
     end
@@ -97,7 +115,7 @@ module Relinkly
     end
 
     # POST /v1/links
-    def shorten(destination, options = {})
+    def shorten(destination, options: {})
       options[:destination] = destination
       Link.new(relinkly_request(:post, 'links', options))
     end
@@ -112,10 +130,61 @@ module Relinkly
       Link.new(relinkly_request(:delete, "links/#{id}", options))
     end
 
+    # DELETE /v1/links
+    def delete_links(options: {})
+      Link.new(relinkly_request(:delete, 'links', options))
+    end
+
+    # GET /v1/links/:id/tags
     def tags_link(id, options = {})
       Link.new(relinkly_request(:get, "/links/#{id}/tags", options))
     end
 
+    # POST /v1/links/:id/tags/:tag
+    def add_tags_link(id, tag, options: {})
+      Link.new(relinkly_request(:post, "/links/#{id}/tags/#{tag}", options))
+    end
+
+    # DELETE /v1/links/:id/tags/:tag
+    def delete_tags_link(id, tag, options: {})
+      Link.new(relinkly_request(:delete, "/links/#{id}/tags/#{tag}", options))
+    end
+
+    # GET /v1/links/:id/scripts
+    def scripts_link(id, options: {})
+      Link.new(relinkly_request(:get, "/links/#{id}/scripts", options))
+    end
+
+    # POST /v1/links/:id/scripts/:script
+    def add_scripts_link(id, script, options: {})
+      Link.new(relinkly_request(:post, "/links/#{id}/scripts/#{script}", options))
+    end
+
+    # DELETE /v1/links/:id/scripts/:script
+    def delete_scripts_link(id, script, options: {})
+      Link.new(relinkly_request(:delete, "/links/#{id}/scripts/#{script}", options))
+    end
+
+    # SCRIPTS ENDPOINTS
+    #
+    ########################################
+
+    # GET /v1/scripts
+    def scripts(options: {})
+      all_scripts = relinkly_request(:get, 'scripts', options)
+      all_scripts.map { |script| Script.new(script) }
+    end
+
+    # GET /v1/scripts/:id
+    def script(id)
+      Script.new(relinkly_request(:get, "scripts/#{id}"))
+    end
+
+    # GET /v1/scripts/count
+    def script_count(_options: {})
+      relinkly_request(:get, 'scripts/count')['count']
+    end
+
     private
 
     def relinkly_request(method, url, options = {})

data/lib/relinkly/domain.rb

@@ -2,8 +2,8 @@
 
 module Relinkly
   class Domain < Element
-    attr_accessor :id, :ref, :full_name, :top_level_domain, :level,
-                  :created_at, :updated_at, :custom_homepage, :owner_id, :type,
-                  :subdomains, :managed, :status, :https, :active
+    attr_accessor :id, :ref, :full_name, :top_level_domain, :level, :created_at, :updated_at,
+                  :custom_homepage, :owner_id, :type, :subdomains, :managed, :status, :https,
+                  :active
   end
 end

data/lib/relinkly/link.rb

@@ -2,11 +2,9 @@
 
 module Relinkly
   class Link < Element
-    attr_accessor :id, :link_id, :title, :slashtag, :destination, :created_at,
-                  :updated_at, :status, :tags, :scripts, :forward_parameters,
-                  :clicks, :last_click_date, :last_click_at, :is_public,
-                  :short_url, :domain_id, :domain_name,
-                  :https, :favourite
+    attr_accessor :id, :link_id, :title, :slashtag, :destination, :created_at, :updated_at, :status,
+                  :tags, :scripts, :forward_parameters, :clicks, :last_click_date, :last_click_at,
+                  :is_public, :short_url, :domain_id, :domain_name, :https, :favourite
 
     # Associations
     %i[domain creator integration].each do |association|

data/lib/relinkly/script.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Relinkly
+  class Script < Element
+    attr_accessor :id, :name, :uri
+  end
+end

data/lib/relinkly/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Relinkly
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/lib/relinkly.rb

@@ -10,6 +10,7 @@ require 'relinkly/integration'
 require 'relinkly/link'
 require 'relinkly/workspace'
 require 'relinkly/tag'
+require 'relinkly/script'
 
 module Relinkly
   class << self

data/relinkly.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.name          = "relinkly"
   spec.version       = Relinkly::VERSION
   spec.authors       = ["Rajan Bhattarai"]
-  spec.email         = ["hey@rajanbhattarai.com"]
+  spec.email         = ["rajan@rajanbhattarai.com"]
 
   spec.summary       = "A Ruby wrapper for the Rebrandly API "
   spec.description   = "Easily create short links on your ruby apps using Rebrandly API."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relinkly
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Rajan Bhattarai
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-01 00:00:00.000000000 Z
+date: 2025-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,14 +68,13 @@ dependencies:
         version: 0.18.1
 description: Easily create short links on your ruby apps using Rebrandly API.
 email:
-- hey@rajanbhattarai.com
+- rajan@rajanbhattarai.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -90,6 +89,7 @@ files:
 - lib/relinkly/element.rb
 - lib/relinkly/integration.rb
 - lib/relinkly/link.rb
+- lib/relinkly/script.rb
 - lib/relinkly/tag.rb
 - lib/relinkly/version.rb
 - lib/relinkly/workspace.rb
@@ -98,7 +98,7 @@ homepage: https://github.com/cdrrazan/relinkly
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -113,8 +113,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key: 
+rubygems_version: 3.4.17
+signing_key:
 specification_version: 4
 summary: A Ruby wrapper for the Rebrandly API
 test_files: []

data/.travis.yml

@@ -1,5 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.6
-before_install: gem install bundler -v 2.2.3