relinkly 1.0.0 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ef98f2ea27c1567b2293b703fefabf90c70cbce7fbaa3dfbad54429539e5dca
-  data.tar.gz: f9185277790a1e86bfccb3a779aa9b4e07986040d64dde19a49df738cb4a281d
+  metadata.gz: ca3d464fc600ace0e0982fbb9a910796a4688b27737f86a443381360b177d092
+  data.tar.gz: 7c52ecef421d2b51b0a447e5f69013cc5745b1b29be395542c8945e7ae0cf390
 SHA512:
-  metadata.gz: 2b149562182bc84a107d8279f5beabf470a9dfc95cc3227d97f1ee4553c6d536dcd43c956d4b148e3b686a387a218d249bad6758f79e57c3a90064fd432f920e
-  data.tar.gz: 70422410b36a9a0af25558e01413ef0475f4b8ca39d3daa4de18ac90b3fdfabeb9d3856e2898943d3517392f67f306e8fb204ccab503d93c566331296a7ecb63
+  metadata.gz: 63e74e9104608ac8d717b5edc14e72878c54abb616a5269fc6b619e907ff469b663c8e0613bc4aaf24e0f62f244cb79a7d0d06483e1fde0c41209e5ba85a0551
+  data.tar.gz: e82e824a00937180539f49e007257a07cd321126f48b3c0ea1f64261d16f5cd43156a41b8e761ef13ab70d101c1335b9c0094bbd33ab2d87370f726182b77826

data/.gitignore

@@ -9,3 +9,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) [![Build Status](https://travis-ci.com/cyborgINX/relinkly.svg?branch=master)](https://travis-ci.com/cyborgINX/relinkly)
 
 ## Installation
 
@@ -41,13 +41,13 @@ 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
+api.workspaces                      # GET /v1/account/workspaces
 ```
 
 #### Tags
 ```ruby
 api.tags                           # GET /v1/tags
-api.tags(id)                       # GET /v1/tags/:id
+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
@@ -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,16 +66,17 @@ 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
 link = api.shorten('https://google.com', domain: my_domain.to_h, title: 'Google', description: 'Google Homepage')
 ```
 
-### 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.
+#### 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. 
+
+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/lib/relinkly/api.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'httparty'
-require 'pry'
 
 module Relinkly
   class RelinklyError < StandardError; end
@@ -12,26 +11,23 @@ module Relinkly
     API_VERSION = 'v1'
     BASE_URL = "https://api.rebrandly.com/#{API_VERSION}"
 
-    ###########################################################
-    # ACCOUNT ENDPOINT
-    # #########################################################
+    # ACCOUNT ENDPOINTS
+
     # 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
-    # #########################################################
+    # DOMAINS ENDPOINTS
+
     # GET /v1/domains
     def domains(options = {})
       all_domains = relinkly_request(:get, 'domains', options)
@@ -48,9 +44,8 @@ module Relinkly
       relinkly_request(:get, 'domains/count')['count']
     end
 
-    ###########################################################
-    # TAGS ENDPOINT
-    # #########################################################
+    # TAGS ENDPOINTS
+
     # GET /v1/tags
     def tags(options = {})
       all_tags = relinkly_request(:get, 'tags', options)
@@ -83,9 +78,8 @@ module Relinkly
       Tag.new(relinkly_request(:delete, "tags/#{id}", options))
     end
 
-    ###########################################################
-    # LINKS ENDPOINT
-    # #########################################################
+    # LINKS ENDPOINTS
+
     # GET /v1/links
     def links(options = {})
       all_links = relinkly_request(:get, 'links', options)
@@ -130,7 +124,7 @@ module Relinkly
       options = Hash[options.map { |k, v| [k.to_s.relinkly_lower_camelize.to_sym, v] }]
       workspace_id = options[:workspace]
 
-      # Passes the Workspace_id into header if the link is to be created into specific workspace
+      # Passes the workspace_id into header if the operation requires workspace_id to be included.
       header_with_workspace = workspace_id.nil? ? headers : headers.merge!('workspace' => workspace_id)
       http_attrs = { headers: header_with_workspace }
       case method
@@ -138,6 +132,8 @@ 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/link.rb

@@ -5,8 +5,7 @@ module Relinkly
     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
+                  :short_url, :domain_id, :domain_name, :https, :favourite
 
     # Associations
     %i[domain creator integration].each do |association|

data/lib/relinkly/version.rb

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

data/lib/relinkly/workspace.rb

@@ -2,7 +2,6 @@
 
 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/relinkly.gemspec

@@ -7,10 +7,10 @@ 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."
+  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.homepage      = "https://github.com/cdrrazan/relinkly"
   spec.license       = "MIT"
 
@@ -24,6 +24,5 @@ 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: 1.0.0
+  version: 1.0.2
 platform: ruby
 authors:
 - Rajan Bhattarai
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-31 00:00:00.000000000 Z
+date: 2025-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,20 +52,6 @@ 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
@@ -80,9 +66,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.18.1
-description: Easily create short links on your ruby apps using Rebrandly API.
+description: Easily create short links on your ruby apps using your favorite link
+  shortner app's API.
 email:
-- hey@rajanbhattarai.com
+- rajan@rajanbhattarai.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -112,7 +99,7 @@ homepage: https://github.com/cdrrazan/relinkly
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -127,8 +114,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
+summary: A Ruby wrapper for the Your Favorite Link Shortner API
 test_files: []