onlyoffice_digitalocean_wrapper 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 722a209dd7c530acc9eca5dc95af3482ce07b031f1d60458f0fd4f60d68d97f1
-  data.tar.gz: 2176a7c8518150703d75437360e757e2be7e6ed770affb877fb02dfc362f2124
+  metadata.gz: 36e4b1f04e6c0aebdbfeb107f577a367bf298c8c4004955734110db26b01b7a6
+  data.tar.gz: 375770be15fc82e73619aab137d83ab5e8824a1a6097854064c63e42588471c2
 SHA512:
-  metadata.gz: efec409153d5b1d2c94d8ef541ed957f708869b5096c42371224d389adab3d7282d0eccb0e56bb40a30dc6e5a43989eae1c2aeb73830346138f9f20511424e31
-  data.tar.gz: 5680e5bc73b4fd25f402fa18de9b788008710ef00fac98dff796e958e1e3e45c682563eeeb169a5b2871af8898a7247e975c81b5f1bf91fe793cb5448714bf6e
+  metadata.gz: 8eaeba9c86ab045ceb854020ac05f6fb4672e2931b9485ddc5284800afd1d6d7a6e024198032c04be38a17a3d4e4d2bcc4259614f86f15976787c5527c38409d
+  data.tar.gz: 300403c3cb2ac438cc7f8c4a57853034ed28d5eb77a3c2109bd1b0a8aeac45ff03e1d0896098a6d412fe2e11d2c4f64a7757618f4f4b3ed6c839a580ffef8e18

data/lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/exceptions_retryer.rb

@@ -15,7 +15,7 @@ module OnlyofficeDigitaloceanWrapper
         yield
       rescue exception => e
         try += 1
-        logger.error("Error '#{exception}, #{e}' happened during "\
+        logger.error("Error '#{exception}, #{e}' happened during " \
                      "operation. Retrying #{try} of #{retries}")
         sleep timeout # Time to cooldown error
         try <= retries ? retry : raise

data/lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/getters.rb

@@ -93,14 +93,5 @@ module OnlyofficeDigitaloceanWrapper
         end
       end
     end
-
-    # Get public ip of droplet
-    # @param [DropletKit] droplet to get ip
-    # @return [String] public ip
-    def public_ip(droplet)
-      networks = droplet.networks.to_a.first
-      public_network = networks.find { |net| net.type == 'public' }
-      public_network.ip_address
-    end
   end
 end

data/lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/ip_getters.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module OnlyofficeDigitaloceanWrapper
+  # Get methods for IP
+  module IpGetters
+    # Get ip of droplet
+    # @param [DropletKit] droplet to get ip
+    # @param [String] network_type to get ip
+    # @return [String, nil] ip of droplet or `nil` if there is no such network
+    def droplet_ip(droplet, network_type = 'public')
+      networks = droplet.networks.to_a.first
+      specific_network = networks.find { |net| net.type == network_type }
+      return nil unless specific_network
+
+      specific_network.ip_address
+    end
+
+    # Get public ip of droplet
+    # @param [DropletKit] droplet to get ip
+    # @return [String, nil] public ip or `nil` if there is no such network
+    def public_ip(droplet)
+      droplet_ip(droplet, 'public')
+    end
+  end
+end

data/lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/token_methods.rb

@@ -20,7 +20,9 @@ module OnlyofficeDigitaloceanWrapper
     # @return [String] token
     def read_token(token_file_path: "#{Dir.home}/.do/access_token",
                    force_file_read: false)
-      return ENV['DO_ACCESS_TOKEN'] if ENV['DO_ACCESS_TOKEN'] && !force_file_read
+      # rubocop:disable Style/FetchEnvVar
+      return ENV['DO_ACCESS_TOKEN'] if ENV.key?('DO_ACCESS_TOKEN') && !force_file_read
+      # rubocop:enable Style/FetchEnvVar
 
       File.read(token_file_path).delete("\n")
     rescue Errno::ENOENT

data/lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper.rb

@@ -4,6 +4,7 @@ require 'droplet_kit'
 require_relative 'digitalocean_wrapper/digitalocean_exceptions'
 require_relative 'digitalocean_wrapper/exceptions_retryer'
 require_relative 'digitalocean_wrapper/getters'
+require_relative 'digitalocean_wrapper/ip_getters'
 require_relative 'digitalocean_wrapper/logger_wrapper'
 require_relative 'digitalocean_wrapper/power_actions'
 require_relative 'digitalocean_wrapper/token_methods'
@@ -13,6 +14,7 @@ module OnlyofficeDigitaloceanWrapper
   # Class for wrapping DigitalOcean API gem
   class DigitalOceanWrapper
     include Getters
+    include IpGetters
     include LoggerWrapper
     include ExceptionsRetryer
     include PowerActions
@@ -31,15 +33,18 @@ module OnlyofficeDigitaloceanWrapper
     # Wait until droplet has status
     # @param droplet_name [String] name of droplet
     # @param status [String] status to wait
-    # @param params [Hash] additiona params
+    # @param params [Hash] additional params
+    # @option params [Integer] :timeout (300) maximum time to wait in seconds
+    # @option params [Integer] :interval (10) interval time between status checks in seconds
     # @return [Symbol] droplet status after wait over
     def wait_until_droplet_have_status(droplet_name, status = 'active', params = {})
       timeout = params.fetch(:timeout, 300)
+      interval = params.fetch(:interval, 10)
       counter = 0
       while get_droplet_status_by_name(droplet_name) != status && counter < timeout
-        counter += 10
-        sleep 10
-        logger.info("waiting for droplet (#{droplet_name}) to have "\
+        counter += interval
+        sleep(interval)
+        logger.info("waiting for droplet (#{droplet_name}) to have " \
                     "status: #{status} for #{counter} seconds of #{timeout}")
       end
       raise DropletOperationTimeout, "#{droplet_name} was not #{status} for #{timeout}s" if counter >= timeout

data/lib/onlyoffice_digitalocean_wrapper/ssh_checker/ssh_checker_exceptions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OnlyofficeDigitaloceanWrapper
+  # Class raised if droplet ssh is not up for defined timeout
+  class SshCheckerSshUpTimeout < StandardError
+  end
+end

data/lib/onlyoffice_digitalocean_wrapper/ssh_checker.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'net-telnet'
+
+require_relative 'ssh_checker/ssh_checker_exceptions'
+
+module OnlyofficeDigitaloceanWrapper
+  # Class for check if ssh can be connected
+  class SshChecker
+    include LoggerWrapper
+    # @return [String] ip of server
+    attr_reader :ip
+
+    # @param ip [String] ip of server to check
+    def initialize(ip)
+      @ip = ip
+    end
+
+    # Wait until ssh server on server is up and available for connection
+    # @param timeout [Integer] how much we should wait for connection
+    # @return [void]
+    def wait_until_ssh_up(timeout: 60)
+      wait_between_tries = 5
+      tries = timeout / wait_between_tries
+      tries.times do |try|
+        if ssh_up?
+          logger.info("SSH on `#{@ip}` is up. Waiting finished")
+          return true
+        end
+
+        logger.info("SSH on `#{@ip}` is not up. Waited for #{try * wait_between_tries} seconds of #{timeout}")
+        sleep wait_between_tries
+      end
+      raise SshCheckerSshUpTimeout, "SSH on `#{@ip}` is not up for #{timeout} seconds. Could not proceed"
+    end
+
+    # Check is ssh available for connection right now
+    # @return [Boolean]
+    def ssh_up?
+      Net::Telnet.new('Host' => @ip,
+                      'Timeout' => 1,
+                      'Port' => 22)
+      true
+    rescue StandardError
+      false
+    end
+  end
+end

data/lib/onlyoffice_digitalocean_wrapper/version.rb

@@ -2,7 +2,7 @@
 
 module OnlyofficeDigitaloceanWrapper
   # @return [String] version of gem
-  VERSION = '0.7.0'
+  VERSION = '0.9.0'
   # @return [String] name of gem
   NAME = 'onlyoffice_digitalocean_wrapper'
 end

data/lib/onlyoffice_digitalocean_wrapper.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
 require_relative 'onlyoffice_digitalocean_wrapper/digitalocean_wrapper'
+require_relative 'onlyoffice_digitalocean_wrapper/ssh_checker'
 require_relative 'onlyoffice_digitalocean_wrapper/version'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_digitalocean_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.9.0
 platform: ruby
 authors:
 - ONLYOFFICE
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-29 00:00:00.000000000 Z
+date: 2024-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: droplet_kit
@@ -27,131 +27,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: codecov
+  name: net-telnet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: overcommit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.49.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.49.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-- !ruby/object:Gem::Dependency
-  name: yard
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.20
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.9.20
 description: Wrapper gem for DigitalOcean. Use in testing projects
 email:
 - shockwavenn@gmail.com
@@ -165,9 +53,12 @@ files:
 - lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/digitalocean_exceptions.rb
 - lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/exceptions_retryer.rb
 - lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/getters.rb
+- lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/ip_getters.rb
 - lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/logger_wrapper.rb
 - lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/power_actions.rb
 - lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/token_methods.rb
+- lib/onlyoffice_digitalocean_wrapper/ssh_checker.rb
+- lib/onlyoffice_digitalocean_wrapper/ssh_checker/ssh_checker_exceptions.rb
 - lib/onlyoffice_digitalocean_wrapper/version.rb
 homepage: https://github.com/ONLYOFFICE-QA/onlyoffice_digitalocean_wrapper
 licenses:
@@ -178,6 +69,7 @@ metadata:
   documentation_uri: https://www.rubydoc.info/gems/onlyoffice_digitalocean_wrapper
   homepage_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_digitalocean_wrapper
   source_code_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_digitalocean_wrapper
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -186,14 +78,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.5.6
 signing_key: 
 specification_version: 4
 summary: Wrapper gem for DigitalOcean