short_io 0.1.5 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6346ca31672e979ac234744e9119b29cc07986ce270fcd7178801ac0a35f9fe
-  data.tar.gz: 9ffbe3bbeea7ec37b12731a93dc14e340bc9d072021dc3802aeeba4aee59934d
+  metadata.gz: d35d4b4870871ee21159f3e60963f1ae02af40dccdb9bc0ee518a65593c2b190
+  data.tar.gz: f7ed37b624cebc677b3139356007818c1c654972ea0f49b83be553c6fe660736
 SHA512:
-  metadata.gz: e1956a2e4f68e837cdaeba4041de51c1bef13487cabc676f55e5545071cf6919bd0737e48b0167e6bbf426e9e43920c3fd857ec585f56c00f7da6e8c9fb8022a
-  data.tar.gz: 0eb85ba43c57eddfb3776a9a2eae2dc193ffd45e3511c90c2cc46d165b54f89d64a82f07f8a6b7b4a23aee9ef3a3e4dfca053f25b757f9d3f0abf516f35873f6
+  metadata.gz: fc8411a577139d9341cbe90b536ce6d042da4c36621f029d2a4c4588a5406ec8c9c1d4f9e87e73dfd426d7ceeff18640f5233a07451625db73219fce3f82bd13
+  data.tar.gz: a4bd6d18d129e60ac8f9e50f9244e1c883d1ca411bbbd9217cc4fbbacd8ef4e50ba6def774fb3c9ff9a16a7b929cb9fe5a137e236947b9af9976cf01b2b6ba7b

data/.gitignore

@@ -6,3 +6,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+.env
+.envrc

data/.travis.yml

@@ -1,6 +1,8 @@
----
 language: ruby
 cache: bundler
 rvm:
-  - 2.7.1
+- 2.7.1
 before_install: gem install bundler -v 2.1.4
+env:
+  global:
+    secure: N+Yyasma8STO5NFjdcmCrn44Zf7x8SbNs6y4bv/FkB5PwcjHYG2sVU/aRB9u8V5F1TuPC7ZPHu74Q9oXgPq2GBnspCNcdvZKzFKLS7euMF+YOeXYSEl7slVvPSq9muuu5lu0cNJbflbTmSElHMXpshamSJxbr9joSvLZMDnJseHXJ+qPKEByB7YQEAFSThbStlgU3oZbRudbM65UBlwxAZ3PZnQ9voYkqPbPkH41SPhtwhLdIOVNR5EK84yypP8rOCCABsxXtfY7vM/ZQpyt/+Ty4cGHDjhiuxypwRFePr2vOqL/w9C2lRNsTRIDrt/krAh0XojIqeObn8d9ZXj+/59OGtAX5YGYKzfMg5Elar24dxUtgKoduD1MLbMBFhB6C8Ch7ULAGvtBDYFYE+0SaMguMr4ZdbxfsNDXIVHYsezLT27ZhSya8/ZOuHcWnveVTl7gktYaY8gdasyNm/uAP99m7/fFgyPYrSaxzLJXAx4EMFxHQtkNTpowETRYE9GFB77NI2QB4cH/5KeOjsvykm8ipmY5Uyfofqm5DV+vHW3zradgzeDogjgoByFlmtCmBpcnAlbmwygxZP303DlVy1pDjizbvITB5beb3HlHzvGbxFjgwvKvnDibjmsrY9NDz5Qzo7hOaJegenUrdgA8wZwV6JOD2Paz6UqKzi1x+2U=

data/CHANGELOG.md

@@ -1,4 +1,32 @@
-0.1.4 (2021-01-25)
+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)
+------------------
+
+* add webmock gem
+* add test for add_domain and domain list methods
+* 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)
+------------------
+
+* add test
+* add memoization
+* 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)
+------------------
+
+* 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)
 ------------------
 
 * fix CHANGELOG.md path

data/Gemfile

@@ -5,3 +5,9 @@ gemspec
 
 gem "rake", "~> 12.0"
 gem "minitest", "~> 5.0"
+
+group :test do
+  gem 'simplecov', require: false
+  gem 'codecov', require: false
+  gem 'webmock'
+end

data/Gemfile.lock

@@ -1,21 +1,44 @@
 PATH
   remote: .
   specs:
-    short_io (0.1.5)
+    short_io (0.1.9)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    codecov (0.6.0)
+      simplecov (>= 0.15, < 0.22)
+    crack (0.4.5)
+      rexml
+    docile (1.4.0)
+    hashdiff (1.0.1)
+    json (2.6.1)
     minitest (5.15.0)
+    public_suffix (4.0.6)
     rake (12.3.3)
+    rexml (3.2.5)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  codecov
   minitest (~> 5.0)
   rake (~> 12.0)
   short_io!
+  simplecov
+  webmock
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,6 +1,8 @@
-# ShortIoShortBrandedUrl
+# ShortIo
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/short_io`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/short_io.svg)](https://badge.fury.io/rb/short_io) | [![Build Status](https://app.travis-ci.com/yosefbennywidyo/short_io.svg?branch=main)](https://app.travis-ci.com/yosefbennywidyo/short_io) | [![codecov](https://codecov.io/gh/yosefbennywidyo/short_io/branch/main/graph/badge.svg?token=MBMxFB57mZ)](https://codecov.io/gh/yosefbennywidyo/short_io)
+
+A Ruby gem to use with [short.io](https://short.io)
 
 [Short IO documentation](https://developers.short.io/docs/deleting-a-domain)
 

data/lib/short_io/short_url.rb

@@ -3,20 +3,48 @@ 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/'
+
+    attr_reader :host_name, :api_key, :options
     
-    def initialize(host_name = 'example.com', api_key = 'API_KEY', options={})
-      @host_name    = host_name
-      @api_key      = api_key
-      @hide_referer = options.key?(:hide_referer)  ? options[:hide_referer] : false
-      @https_link   = options.key?(:https_link)    ? options[:https_link]   : false
-      @link_type    = options.key?(:link_type)     ? options[:link_type]    : 'random'
-      @short_io_base_url = 'https://api.short.io/domains/'
+    def initialize(host_name, api_key, options={})
+      @host_name          ||= host_name
+      @api_key            ||= api_key
+      @short_io_base_url  ||= SHORT_IO_BASE_URL
+      @options            ||= options
+      options_default_value
+      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,
+        https_link: options.key?(:https_link) ? options[:https_link] : false,
+        link_type: options.key?(:link_type) ? options[:link_type] : 'random'
+      }
+    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)
@@ -24,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
 
@@ -32,15 +84,23 @@ module ShortIo
       request["content-type"] = REQUEST_TYPE
       request["authorization"] = @api_key
       request.body = JSON.generate(
-        {"hideReferer":"#{@hide_referer}",
-        "httpsLinks":"#{@https_link}",
-        "hostname":"#{@host_name}",
-        "linkType":"#{@link_type}"}
+        {
+          "hideReferer":"#{@options[:hide_referer]}",
+          "httpsLinks":"#{@options[:https_link]}",
+          "hostname":"#{@host_name}",
+          "linkType":"#{@options[:link_type]}"
+        }
       )
       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
       request = Net::HTTP::Get.new(@url)

data/lib/short_io/version.rb

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

data/lib/short_io.rb

@@ -3,5 +3,7 @@ require "short_io/short_url"
 
 module ShortIo
   class Error < StandardError; end
+  class HostNameError < Error; end
+  class ApiKeyError < Error; end
   # Your code goes here...
 end

metadata

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