short_io 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '01299ccaa6348aa2c516c54877e28d7c12ffd318056ba5b862c470ef87f0a7dc'
-  data.tar.gz: 619507d110ac39cb4f7930381e30a8c049449249d06bfbc291b77cb1075e5c49
+  metadata.gz: d35d4b4870871ee21159f3e60963f1ae02af40dccdb9bc0ee518a65593c2b190
+  data.tar.gz: f7ed37b624cebc677b3139356007818c1c654972ea0f49b83be553c6fe660736
 SHA512:
-  metadata.gz: b5f397a7d6bee167a5f69da748738f2abd85c052b78adc9cca1f6ace7ce88fd57bf7d77ec32770e5758dffe42d64697986e72b78a5610243fcbe733e960667b6
-  data.tar.gz: 98f790b50b2f830052ac8d6a0e7f8c2b78f9e5c9f052e5ed794abbb2eef641de75df76cb83c2cae4e31ccf387ee30c8e6ea00f167e2c5d4f23bb4db43b5f469e
+  metadata.gz: fc8411a577139d9341cbe90b536ce6d042da4c36621f029d2a4c4588a5406ec8c9c1d4f9e87e73dfd426d7ceeff18640f5233a07451625db73219fce3f82bd13
+  data.tar.gz: a4bd6d18d129e60ac8f9e50f9244e1c883d1ca411bbbd9217cc4fbbacd8ef4e50ba6def774fb3c9ff9a16a7b929cb9fe5a137e236947b9af9976cf01b2b6ba7b

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+0.1.9 (2021-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)
 ------------------
 

data/Gemfile.lock

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

data/lib/short_io/short_url.rb

@@ -3,7 +3,9 @@ require 'net/http'
 require 'openssl'
 require 'json'
 
+# @author Yosef Benny Widyokarsono
 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/'
@@ -19,6 +21,10 @@ module ShortIo
       check_variables
     end
 
+    # Options Default Value
+    #
+    # @return [Hash] return default options in Hash if no value provided.
+
     def options_default_value
       @options = {
         hide_referer: options.key?(:hide_referer) ? options[:hide_referer] : false,
@@ -27,11 +33,18 @@ module ShortIo
       }
     end
 
+    # Check Variables
+    #
+    # @raise [HostNameError] if no Host Name provided.
+    # @raise [ApiKeyError] if no API Key provided.
+
     def check_variables
       raise ShortIo::HostNameError.new(host_name: 'Please provide a host name') if (@host_name.nil? || @host_name.empty?)
       raise ShortIo::ApiKeyError.new(api_key: 'Please provide an API key') if (@api_key.nil? || @api_key.empty?)
     end
 
+    # Prepare request
+
     def setup
       @url = URI(SHORT_IO_BASE_URL)
       @http = Net::HTTP.new(@url.host, @url.port)
@@ -39,6 +52,30 @@ module ShortIo
       @http.verify_mode = OpenSSL::SSL::VERIFY_NONE
     end
 
+    # Add new domain
+    #
+    # @return [JSON] return in JSON format.
+    #
+    # @example
+    #   ShortIo::ShortUrl.new('example.com', 'YOUR_API_KEY').add_domain
+    #     {
+    #       linkType: 'random',
+    #       state: 'configured',
+    #       cloaking: false,
+    #       setupType: 'dns',
+    #       httpsLinks: false,
+    #       id: 91576,
+    #       hostname: 'yourdomain.com',
+    #       UserId: 9346,
+    #       updatedAt: '2022-02-03T10:22:47.010Z',
+    #       createdAt: '2022-02-03T10:22:46.649Z',
+    #       provider: null,
+    #       unicodeHostname: 'urdomain.com',
+    #       clientStorage: null
+    #     }
+    #
+    # @see https://developers.short.io/docs/adding-a-domain
+
     def add_domain
       setup
 
@@ -57,6 +94,12 @@ module ShortIo
       response = @http.request(request)
       return response.read_body
     end
+
+    # Domain List
+    #
+    # @return [JSON] return domain list in JSON format.
+    #
+    # @see https://developers.short.io/docs/getting-a-list-of-domains
     
     def domain_list
       setup

data/lib/short_io/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: short_io
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Yosef Benny Widyokarsono