relinkly 1.0.2 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca3d464fc600ace0e0982fbb9a910796a4688b27737f86a443381360b177d092
-  data.tar.gz: 7c52ecef421d2b51b0a447e5f69013cc5745b1b29be395542c8945e7ae0cf390
+  metadata.gz: afd77fb83655421ffccdcc5930da3f15133eeaf47f0205a8ef103bd50fe94efb
+  data.tar.gz: 6b60e768e3699c93f0d84d33f64b5edee55ef8a6a02c12afcd2ece12ab1a0328
 SHA512:
-  metadata.gz: 63e74e9104608ac8d717b5edc14e72878c54abb616a5269fc6b619e907ff469b663c8e0613bc4aaf24e0f62f244cb79a7d0d06483e1fde0c41209e5ba85a0551
-  data.tar.gz: e82e824a00937180539f49e007257a07cd321126f48b3c0ea1f64261d16f5cd43156a41b8e761ef13ab70d101c1335b9c0094bbd33ab2d87370f726182b77826
+  metadata.gz: 167554f6e43ab5eeeaefd3870322f168b2a28fbcfdf5817ae658b5cb849b031c3b86314e8a6f9a1908bbefd90f56d3c1ab0ac9fc09bbc9f00c487c1b55f603a5
+  data.tar.gz: 26c87be5be87cf0ce5c1cd896e795cef98b563c3b6d0e3a676f4c6c2b9cd40fd5f496937c7a0916dd20ac5d130f2bb1bc1a09476498408bd90dbb86f7a6db815

data/.gitignore

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

data/README.md

@@ -1,4 +1,4 @@
-# relinkly [![Gem Version](https://badge.fury.io/rb/relinkly.svg)](https://badge.fury.io/rb/relinkly) [![Build Status](https://travis-ci.com/cyborgINX/relinkly.svg?branch=master)](https://travis-ci.com/cyborgINX/relinkly)
+# relinkly [![Gem Version](https://badge.fury.io/rb/relinkly.svg)](https://badge.fury.io/rb/relinkly)
 
 ## Installation
 
@@ -35,23 +35,14 @@ api = Relinkly::API.new
 
 ### API Requests
 
-#### Account and Workspaces
+#### Account, Workspaces & Domains
+
 ```ruby
+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
-api.account                         # GET /v1/account
-api.workspaces                      # GET /v1/account/workspaces
-```
-
-#### Tags
-```ruby
-api.tags                           # GET /v1/tags
-api.tag(id)                        # GET /v1/tags/:id
-api.tag_count(options)             # GET /v1/tags/count
-api.new_tag(options)               # GET /v1/tags/new
-api.update_tag(id, options)        # POST /v1/tags/:id
-api.delete_tag(id, options)        # DELETE /v1/tags/:id
 ```
 
 #### Links
@@ -62,29 +53,53 @@ 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
+```ruby
+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
+```ruby
+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!
 
 ```ruby
-my_domain = api.domains.first
-link = api.shorten('https://google.com', domain: my_domain.to_h, title: 'Google', description: 'Google Homepage')
+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 perform operations other than the default 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 select other than the default workspace.
 
-Here's how you can create a link into another workspace. 
+Here's how you can achieve that:
 
 ```ruby
-my_domain = api.domains.first
-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)
+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 `my_domain` should already be included inside `my_workspace`. Similarly other operations on link and tags can be achieved as above.
+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
 

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 = {})
@@ -132,8 +201,6 @@ module Relinkly
         http_attrs.merge!(query: options)
       when :post
         http_attrs.merge!(body: options.to_json)
-      else
-          # type code here
       end
 
       res = HTTParty.send(method, url, http_attrs)

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,10 +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.2'
+  VERSION = '1.1.1'
 end

data/lib/relinkly/workspace.rb

@@ -2,6 +2,7 @@
 
 module Relinkly
   class Workspace < Element
-    attr_accessor :id, :name, :avatarUrl, :links, :teammates, :domains, :created_at, :updated_at
+    attr_accessor :id, :name, :avatarUrl, :links, :teammates,
+                  :domains, :created_at, :updated_at
   end
 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

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Rajan Bhattarai"]
   spec.email         = ["rajan@rajanbhattarai.com"]
 
-  spec.summary       = "A Ruby wrapper for the Your Favorite Link Shortner API "
-  spec.description   = "Easily create short links on your ruby apps using your favorite link shortner app's API."
+  spec.summary       = "A Ruby wrapper for the Rebrandly API "
+  spec.description   = "Easily create short links on your ruby apps using Rebrandly API."
   spec.homepage      = "https://github.com/cdrrazan/relinkly"
   spec.license       = "MIT"
 
@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 2.2.3"
-  spec.add_development_dependency "rake", "~> 13.0.3"
-  spec.add_development_dependency "rspec", "~> 3.10.0"
-  spec.add_dependency 'httparty', '~> 0.18.1'
+  spec.add_development_dependency "bundler", "~> 2.6.2"
+  spec.add_development_dependency "rake", "~> 13.2.1"
+  spec.add_development_dependency "rspec", "~> 3.13.0"
+  spec.add_dependency 'httparty', '~> 0.22.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relinkly
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.1
 platform: ruby
 authors:
 - Rajan Bhattarai
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-01-13 00:00:00.000000000 Z
+date: 2025-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,58 +16,57 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: 2.6.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.2.3
+        version: 2.6.2
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.3
+        version: 13.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.3
+        version: 13.2.1
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        version: 3.13.0
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
+        version: 0.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.18.1
-description: Easily create short links on your ruby apps using your favorite link
-  shortner app's API.
+        version: 0.22.0
+description: Easily create short links on your ruby apps using Rebrandly API.
 email:
 - rajan@rajanbhattarai.com
 executables: []
@@ -76,7 +75,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -91,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
@@ -117,5 +116,5 @@ requirements: []
 rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
-summary: A Ruby wrapper for the Your Favorite Link Shortner API
+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