short_io 0.1.9 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d35d4b4870871ee21159f3e60963f1ae02af40dccdb9bc0ee518a65593c2b190
-  data.tar.gz: f7ed37b624cebc677b3139356007818c1c654972ea0f49b83be553c6fe660736
+  metadata.gz: b501e26aa3a32c19f90bb55620f0a7ec11603a861676eefa40d6f412448085d2
+  data.tar.gz: a72bb745a6f65bca47290fee7d783ae24ed44de296dce5492da3e5e6e734fbe9
 SHA512:
-  metadata.gz: fc8411a577139d9341cbe90b536ce6d042da4c36621f029d2a4c4588a5406ec8c9c1d4f9e87e73dfd426d7ceeff18640f5233a07451625db73219fce3f82bd13
-  data.tar.gz: a4bd6d18d129e60ac8f9e50f9244e1c883d1ca411bbbd9217cc4fbbacd8ef4e50ba6def774fb3c9ff9a16a7b929cb9fe5a137e236947b9af9976cf01b2b6ba7b
+  metadata.gz: 357d0b28e2f88b5e035865bd748bbc832cb3a34bb609e74c346e2f862164a56a6bf4d5a0860ece3c49a12746b9833657852f35376a378a0cba83232ed11a5f77
+  data.tar.gz: 97ba7f73234f850b3e219233121b33f3b3a14804b0732fc177884fe622628558b79fce2e96a63cf2881c063d17e7ffb564624ce5218fbc03a91c7088ec62e3d4

data/CHANGELOG.md

@@ -1,10 +1,19 @@
-0.1.9 (2021-02-03)
+0.1.10 (2022-02-10)
+------------------
+
+* add delete and update method
+* initialize using four (4) parameters
+* setup method using two (2) default parameters
+* add documentation for domain_list, update, and delete
+* update version to [0.1.10](https://rubygems.org/gems/short_io/versions/0.1.10)
+
+0.1.9 (2022-02-03)
 ------------------
 
 * add documentation
 * update version to [0.1.9](https://rubygems.org/gems/short_io/versions/0.1.9)
 
-0.1.8 (2021-02-03)
+0.1.8 (2022-02-03)
 ------------------
 
 * add webmock gem
@@ -12,7 +21,7 @@
 * add `:host_name`, `:api_key`, and `:options` attr_reader
 * update version to [0.1.8](https://rubygems.org/gems/short_io/versions/0.1.8)
 
-0.1.7 (2021-01-25)
+0.1.7 (2022-01-25)
 ------------------
 
 * add test
@@ -20,42 +29,42 @@
 * add check_variables method to raise error when `nil` or `empty` on host name or api_key
 * update version to [0.1.7](https://rubygems.org/gems/short_io/versions/0.1.7)
 
-0.1.6 (2021-01-25)
+0.1.6 (2022-01-25)
 ------------------
 
 * fix version on CHANGELOG.md
 * update version to [0.1.6](https://rubygems.org/gems/short_io/versions/0.1.6)
 
-0.1.5 (2021-01-25)
+0.1.5 (2022-01-25)
 ------------------
 
 * fix CHANGELOG.md path
 * update version to [0.1.5](https://rubygems.org/gems/short_io/versions/0.1.5)
 
-0.1.4 (2021-01-25)
+0.1.4 (2022-01-25)
 ------------------
 
 * add CHANGELOG.md
 * update version to [0.1.4](https://rubygems.org/gems/short_io/versions/0.1.4)
 
-0.1.3 (2021-01-25)
+0.1.3 (2022-01-25)
 ------------------
 
 * add Gemfile.lock
 * update version to [0.1.3](https://rubygems.org/gems/short_io/versions/0.1.3)
 
-0.1.2 (2021-01-25)
+0.1.2 (2022-01-25)
 ------------------
 
 * fix sample usage on README.md
 * update version to [0.1.2](https://rubygems.org/gems/short_io/versions/0.1.2)
 
-0.1.1 (2021-01-25)
+0.1.1 (2022-01-25)
 ------------------
 
 * update version to [0.1.1](https://rubygems.org/gems/short_io/versions/0.1.1) (no changes)
 
-0.1.0 (2021-01-25)
+0.1.0 (2022-01-25)
 ------------------
 
 * [YANKED](https://rubygems.org/gems/short_io/versions/0.1.0) Start create `short_io` gem

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    short_io (0.1.9)
+    short_io (0.1.10)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -4,7 +4,7 @@
 
 A Ruby gem to use with [short.io](https://short.io)
 
-[Short IO documentation](https://developers.short.io/docs/deleting-a-domain)
+[ShortIo gem documentation](https://rubydoc.info/gems/short_io)
 
 ## Installation
 

data/lib/short_io/short_url.rb

@@ -7,18 +7,21 @@ require 'json'
 module ShortIo
   # Add domain and list domains registerd to Short.io
   class ShortUrl
-    REQUEST_TYPE      = 'application/json'
-    SHORT_IO_BASE_URL = 'https://api.short.io/domains/'
+    REQUEST_TYPE          = 'application/json'
+    SHORT_IO_BASE_URL     = 'https://api.short.io/domains/'
+    SHORT_IO_API_BASE_URL = 'https://api.short.io/api/domains'
 
     attr_reader :host_name, :api_key, :options
     
-    def initialize(host_name, api_key, options={})
+    def initialize(host_name, api_key, short_io_base_url=SHORT_IO_BASE_URL, options={})
       @host_name          ||= host_name
       @api_key            ||= api_key
-      @short_io_base_url  ||= SHORT_IO_BASE_URL
+      @short_io_base_url  ||= short_io_base_url
       @options            ||= options
-      options_default_value
-      check_variables
+      unless options.key?(:domain_id)
+        options_default_value
+        check_variables
+      end
     end
 
     # Options Default Value
@@ -45,8 +48,8 @@ module ShortIo
 
     # Prepare request
 
-    def setup
-      @url = URI(SHORT_IO_BASE_URL)
+    def setup(action=nil, base_url=SHORT_IO_BASE_URL)
+      @url = action.nil? ? URI(base_url) : URI(base_url + action)
       @http = Net::HTTP.new(@url.host, @url.port)
       @http.use_ssl = true
       @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
@@ -95,17 +98,97 @@ module ShortIo
       return response.read_body
     end
 
+    # Delete a domain
+    #
+    # @return [JSON] return in JSON format.
+    #
+    # @example
+    #   ShortIo::ShortUrl.new('example.com', 'YOUR_API_KEY', {domain_id: YOUR_DOMAIN_ID}).delete_domain
+    #     response:
+    #     {
+    #       success: true
+    #     }
+    #
+    # @see https://developers.short.io/docs/deleting-a-domain
+
+    def delete_domain
+      setup("delete/#{@options[:domain_id]}")
+
+      request = Net::HTTP::Post.new(@url)
+      request["authorization"] = @api_key
+
+      response = @http.request(request)
+      return response.read_body
+    end
+
+    # Udpadating a domain
+    #
+    # @return [JSON] return in JSON format.
+    #
+    # @example
+    #   ShortIo::ShortUrl.new('example.com', 'YOUR_API_KEY', {domain_id: YOUR_DOMAIN_ID, root_redirect_url: 'YOUR_LINK'}).update_domain
+    #     response:
+    #     {
+    #       success: true
+    #     }
+    #
+    # @see https://developers.short.io/docs/updating-a-domain
+
+    def update_domain
+      setup("settings/#{@options[:domain_id]}")
+
+      request = Net::HTTP::Post.new(@url)
+      request["accept"] = REQUEST_TYPE
+      request["content-type"] = REQUEST_TYPE
+      request["authorization"] = @api_key
+      request.body = JSON.generate({ 'rootRedirect': "#{@options[:root_redirect_url]}" })
+
+      response = @http.request(request)
+      return response.read_body
+    end
+
     # Domain List
     #
     # @return [JSON] return domain list in JSON format.
     #
+    # @example
+    #   ShortIo::ShortUrl.new('example.com', 'YOUR_API_KEY').domain_list
+    #     response:
+    #     {
+    #       id: 7252,
+    #      hostname: 'yrbrand.co',
+    #      title: null,
+    #      segmentKey: null,
+    #      linkType: 'increment',
+    #      state: 'not_configured',
+    #      provider: 'cloudflare',
+    #      redirect404: 'https://short.cm',
+    #      hideReferer: 1,
+    #      caseSensitive: true,
+    #      exportEnabled: true,
+    #      cloaking: false,
+    #      jsRedir: true,
+    #      incrementCounter: 'A',
+    #      setupType: 'js',
+    #      autodeletePeriod: 1,
+    #      httpsLinks: true,
+    #      clientStorage: '{"configurationHidden":false}',
+    #      integrationGA: null,
+    #      integrationFB: null,
+    #      integrationAdroll: null,
+    #      integrationGTM: null,
+    #      createdAt: '2017-12-07T08:24:41.000Z',
+    #      updatedAt: '2019-12-24T13:08:30.000Z',
+    #      TeamId: 1381,
+    #      unicodeHostname: 'yrbrand.co'
+    #    }
+    #
     # @see https://developers.short.io/docs/getting-a-list-of-domains
     
     def domain_list
-      setup
+      setup(nil, SHORT_IO_API_BASE_URL)
       request = Net::HTTP::Get.new(@url)
       request["accept"] = REQUEST_TYPE
-      request["content-type"] = REQUEST_TYPE
       request["authorization"] = @api_key
       
       response = @http.request(request)

data/lib/short_io/version.rb

@@ -1,3 +1,3 @@
 module ShortIo
-  VERSION = "0.1.9"
+  VERSION = "0.1.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: short_io
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors:
 - Yosef Benny Widyokarsono
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-02 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies: []
 description:
 email: