short_io 0.1.6 → 0.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eeae1a268f6b5060f6df86afd2af9156137a49c889fda818774b7e9b285a7c4d
-  data.tar.gz: 102a515ab66654bb4e211b158a10c6273a1ffbdc6fa5de628a57c9ea19e5374f
+  metadata.gz: b501e26aa3a32c19f90bb55620f0a7ec11603a861676eefa40d6f412448085d2
+  data.tar.gz: a72bb745a6f65bca47290fee7d783ae24ed44de296dce5492da3e5e6e734fbe9
 SHA512:
-  metadata.gz: b19f0eb932a6f64fba5f528b4d04380ac103397223cd2618e571baa4c83eec5f982bf74692b6535da7c8092b745f7b55e06e9fc15dd9ef68989d2be2fc1aa324
-  data.tar.gz: b6e1734c29a6256a262e322658900c6743352b6a0397ea5427de5fba2fa71a0796e9ad1d4e963a3a22e52a3fa5faf4180674c9ed6830f9513e84498d2551bf30
+  metadata.gz: 357d0b28e2f88b5e035865bd748bbc832cb3a34bb609e74c346e2f862164a56a6bf4d5a0860ece3c49a12746b9833657852f35376a378a0cba83232ed11a5f77
+  data.tar.gz: 97ba7f73234f850b3e219233121b33f3b3a14804b0732fc177884fe622628558b79fce2e96a63cf2881c063d17e7ffb564624ce5218fbc03a91c7088ec62e3d4

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,39 +1,70 @@
-0.1.6 (2021-01-25)
+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 (2022-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 (2022-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 (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

@@ -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.6)
+    short_io (0.1.10)
 
 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,8 +1,10 @@
-# 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)
 
-[Short IO documentation](https://developers.short.io/docs/deleting-a-domain)
+A Ruby gem to use with [short.io](https://short.io)
+
+[ShortIo gem documentation](https://rubydoc.info/gems/short_io)
 
 ## Installation
 

data/lib/short_io/short_url.rb

@@ -3,27 +3,82 @@ 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/'
+    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 = '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, 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
+      @options            ||= options
+      unless options.key?(:domain_id)
+        options_default_value
+        check_variables
+      end
+    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
 
-    def setup
-      @url = URI(SHORT_IO_BASE_URL)
+    # 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(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
     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,20 +87,108 @@ 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
 
+    # 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.6"
+  VERSION = "0.1.10"
 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.6
+  version: 0.1.10
 platform: ruby
 authors:
 - Yosef Benny Widyokarsono
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-25 00:00:00.000000000 Z
+date: 2022-02-10 00:00:00.000000000 Z
 dependencies: []
 description:
 email: