relinkly 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efe951a2ac0f57738160775af7e0ae5d7233527c057eb65fe6b93a96d764fe0b
-  data.tar.gz: 8676c1129862ca4e14cf50a19ce3020b586298778c058fe7dfe95c6c6f5ffb57
+  metadata.gz: 0ef98f2ea27c1567b2293b703fefabf90c70cbce7fbaa3dfbad54429539e5dca
+  data.tar.gz: f9185277790a1e86bfccb3a779aa9b4e07986040d64dde19a49df738cb4a281d
 SHA512:
-  metadata.gz: 13322191a160fcc770f2d827b01ef63621676e018216204ebba6dbdc3c8ecb2b8925a9d9f15cda10bc8c8605d24bf617def43ac25e215c28319a348344da5df1
-  data.tar.gz: 798c9c83492adbf68ee0c33c8e6e50e8805df4ec7c11e5d0e428b15e84a07586ba60746e2f5f47386bb7ae06a95831b02ad388f6ecda2f9e900310e66357fbac
+  metadata.gz: 2b149562182bc84a107d8279f5beabf470a9dfc95cc3227d97f1ee4553c6d536dcd43c956d4b148e3b686a387a218d249bad6758f79e57c3a90064fd432f920e
+  data.tar.gz: 70422410b36a9a0af25558e01413ef0475f4b8ca39d3daa4de18ac90b3fdfabeb9d3856e2898943d3517392f67f306e8fb204ccab503d93c566331296a7ecb63

data/README.md

@@ -35,6 +35,26 @@ api = Relinkly::API.new
 
 ### API Requests
 
+#### Account and Workspaces
+```ruby
+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/workspaces
+```
+
+#### Tags
+```ruby
+api.tags                           # GET /v1/tags
+api.tags(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
 ```ruby
 api.links                           # GET /v1/links
 api.links(id)                       # GET /v1/links/:id
@@ -42,20 +62,30 @@ 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(id, options)             # DELETE /v1/links/:id
-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.delete_link(id, options)        # DELETE /v1/links/:id
+api.tags_link(id, options)          # GET /v1/links/:id/tags
+```
+
+### Make a new 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')
 ```
 
-### Make a new short link
+### 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 created branded link to another workspace.
 
 ```ruby
 my_domain = api.domains.first
-link = api.shorten('https://google.com', domain: my_domain.to_h, title: 'Google', description: 'Google Homepage', favourite: true)
+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
+
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/cdrrazan/relinkly.

data/lib/relinkly.rb

@@ -8,6 +8,8 @@ require 'relinkly/domain'
 require 'relinkly/creator'
 require 'relinkly/integration'
 require 'relinkly/link'
+require 'relinkly/workspace'
+require 'relinkly/tag'
 
 module Relinkly
   class << self

data/lib/relinkly/api.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'httparty'
+require 'pry'
 
 module Relinkly
   class RelinklyError < StandardError; end
@@ -11,6 +12,80 @@ module Relinkly
     API_VERSION = 'v1'
     BASE_URL = "https://api.rebrandly.com/#{API_VERSION}"
 
+    ###########################################################
+    # ACCOUNT ENDPOINT
+    # #########################################################
+    # GET /v1/account
+    def account
+      Creator.new(relinkly_request(:get, 'account'))
+    end
+
+    ###########################################################
+    # WORKSPACES ENDPOINTS
+    # #########################################################
+    # GET /v1/account/workspaces
+    def workspaces(options = {})
+      all_workspaces = relinkly_request(:get, 'account/workspaces', options)
+      all_workspaces.map { |workspace| Workspace.new(workspace) }
+    end
+
+    ###########################################################
+    # DOMAINS ENDPOINT
+    # #########################################################
+    # GET /v1/domains
+    def domains(options = {})
+      all_domains = relinkly_request(:get, 'domains', options)
+      all_domains.map { |domain| Domain.new(domain) }
+    end
+
+    # GET /v1/domains/:id
+    def domain(id)
+      Domain.new(relinkly_request(:get, "domains/#{id}"))
+    end
+
+    # GET /v1/domains/count
+    def domain_count(_options = {})
+      relinkly_request(:get, 'domains/count')['count']
+    end
+
+    ###########################################################
+    # TAGS ENDPOINT
+    # #########################################################
+    # GET /v1/tags
+    def tags(options = {})
+      all_tags = relinkly_request(:get, 'tags', options)
+      all_tags.map { |tag| Tag.new(tag) }
+    end
+
+    # GET /v1/tags/:id
+    def tag(id)
+      Tag.new(relinkly_request(:get, "tags/#{id}"))
+    end
+
+    # GET /v1/tags/count
+    def tag_count(_options = {})
+      relinkly_request(:get, 'tags/count')['count']
+    end
+
+    # POST /v1/tags
+    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 = {})
+      Tag.new(relinkly_request(:post, "tags/#{id}", options))
+    end
+
+    # DELETE /v1/tags/:id
+    def delete_tag(id, options = {})
+      Tag.new(relinkly_request(:delete, "tags/#{id}", options))
+    end
+
+    ###########################################################
+    # LINKS ENDPOINT
+    # #########################################################
     # GET /v1/links
     def links(options = {})
       all_links = relinkly_request(:get, 'links', options)
@@ -39,29 +114,12 @@ module Relinkly
     end
 
     # DELETE /v1/links/:id
-    def delete(id, options = {})
+    def delete_link(id, options = {})
       Link.new(relinkly_request(:delete, "links/#{id}", options))
     end
 
-    # GET /v1/domains
-    def domains(options = {})
-      all_domains = relinkly_request(:get, 'domains', options)
-      all_domains.map { |domain| Domain.new(domain) }
-    end
-
-    # GET /v1/domains/:id
-    def domain(id)
-      Domain.new(relinkly_request(:get, "domains/#{id}"))
-    end
-
-    # GET /v1/domains/count
-    def domain_count(_options = {})
-      relinkly_request(:get, 'domains/count')['count']
-    end
-
-    # GET /v1/account
-    def account
-      Creator.new(relinkly_request(:get, 'account'))
+    def tags_link(id, options = {})
+      Link.new(relinkly_request(:get, "/links/#{id}/tags", options))
     end
 
     private
@@ -70,8 +128,11 @@ module Relinkly
       url = "#{BASE_URL}/#{url}"
       # Convert all hash keys into camel case for Relinkly
       options = Hash[options.map { |k, v| [k.to_s.relinkly_lower_camelize.to_sym, v] }]
+      workspace_id = options[:workspace]
 
-      http_attrs = { headers: headers }
+      # Passes the Workspace_id into header if the link is to be created into specific workspace
+      header_with_workspace = workspace_id.nil? ? headers : headers.merge!('workspace' => workspace_id)
+      http_attrs = { headers: header_with_workspace }
       case method
       when :get
         http_attrs.merge!(query: options)

data/lib/relinkly/tag.rb

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

data/lib/relinkly/version.rb

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

data/lib/relinkly/workspace.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Relinkly
+  class Workspace < Element
+    attr_accessor :id, :name, :avatarUrl, :links, :teammates,
+                  :domains, :created_at, :updated_at
+  end
+end

data/relinkly.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["hey@rajanbhattarai.com"]
 
   spec.summary       = "A Ruby wrapper for the Rebrandly API "
-  spec.description   = "Easily create branded short links in your ruby apps using Rebrandly."
+  spec.description   = "Easily create short links on your ruby apps using Rebrandly API."
   spec.homepage      = "https://github.com/cdrrazan/relinkly"
   spec.license       = "MIT"
 
@@ -24,5 +24,6 @@ Gem::Specification.new do |spec|
   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_development_dependency "pry", "~> 0.13.1"
   spec.add_dependency 'httparty', '~> 0.18.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: relinkly
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Rajan Bhattarai
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-30 00:00:00.000000000 Z
+date: 2020-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.10.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.1
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.18.1
-description: Easily create branded short links in your ruby apps using Rebrandly.
+description: Easily create short links on your ruby apps using Rebrandly API.
 email:
 - hey@rajanbhattarai.com
 executables: []
@@ -90,7 +104,9 @@ files:
 - lib/relinkly/element.rb
 - lib/relinkly/integration.rb
 - lib/relinkly/link.rb
+- lib/relinkly/tag.rb
 - lib/relinkly/version.rb
+- lib/relinkly/workspace.rb
 - relinkly.gemspec
 homepage: https://github.com/cdrrazan/relinkly
 licenses: