onlyoffice_digitalocean_wrapper 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 94fccd0b0f0384b0a7ed421e65c7e90726641e61
-  data.tar.gz: 0ee556325a69a1a183ea610675beb8b938d3df32
+SHA256:
+  metadata.gz: '08215ee49f6936d3f70ed161523fcc48b592c8751d34d7ffbef3307bb40eb749'
+  data.tar.gz: 0dff61f8a1d793aa122ac9da2dc5fb6211c3abd857b648064913a145647e9760
 SHA512:
-  metadata.gz: 6831cb41c10316979e73d3bf13be472927435783ca49bbbaaa89c3681ebbe528f343f3f342dbda077d217d9790658aa7e2877ca3ae60588e05470bd31c8bbdff
-  data.tar.gz: e4193acf767e774180c9c66e35300ad50121821afe505da3fb3c25a9d8e30d3c501bbc989e8970a0f8539aaae924ffc41835895c5db4332eca9470756060d8f1
+  metadata.gz: dd8d6319ac155f23e09a7d5529e0c8ce413a21550f5a017c9b6fd0facf09b80ec9bd9ab65b6eb01ee14defb09f0a125ad3e589f7f9e94e511ac55da7c7b35a9f
+  data.tar.gz: 908593c16b2993bf04ea512a9010e3ee98c7f28eec7cc37819d861a5acc5b8b6b19e3ad7e416ecccf5fe0d3be98ab43e29ffb366545b518933309b24fd87adc8

data/lib/onlyoffice_digitalocean_wrapper.rb

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

data/lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper.rb

@@ -1,78 +1,30 @@
+# frozen_string_literal: true
+
 require 'droplet_kit'
 require 'onlyoffice_logger_helper'
 require_relative 'digitalocean_wrapper/digitalocean_exceptions'
+require_relative 'digitalocean_wrapper/exceptions_retryer'
+require_relative 'digitalocean_wrapper/getters'
+require_relative 'digitalocean_wrapper/power_actions'
+require_relative 'digitalocean_wrapper/token_methods'
 
 module OnlyofficeDigitaloceanWrapper
   # Class for wrapping DigitalOcean API gem
   class DigitalOceanWrapper
+    include Getters
+    include ExceptionsRetryer
+    include PowerActions
+    include TokenMethods
+
+    DROPLET_SIZES = %w[512mb 1gb 2gb 4gb 8gb 16gb 32gb 48gb 64gb].freeze
     attr_accessor :client
 
     def initialize(access_token = nil)
-      access_token ||= DigitalOceanWrapper.read_token
+      access_token ||= read_token
       @client = DropletKit::Client.new(access_token: access_token)
       raise ArgumentError, 'DigitalOceanWrapper: Your Access Token is Incorrect' unless correct_access_token?
     end
 
-    # Check if access token is correct
-    # @return [true, false] result of check
-    def correct_access_token?
-      begin
-        @client.droplets.all.first
-      rescue DropletKit::Error
-        return false
-      end
-      true
-    end
-
-    # Check if token is correct. If not trying to read new token
-    # If reading failed - fail
-    def assure_correct_token
-      return if correct_access_token?
-      @client = DropletKit::Client.new(access_token: DigitalOceanWrapper.read_token)
-      return if correct_access_token?
-      raise ArgumentError, 'Access token for DigitalOcean API is incorrect'
-    end
-
-    def get_image_id_by_name(image_name)
-      assure_correct_token
-      all_droplets = @client.images.all
-      image = all_droplets.find { |x| x.name == image_name }
-      raise DigitalOceanImageNotFound, image_name if image.nil?
-      OnlyofficeLoggerHelper.log("get_image_id_by_name(#{image_name}): #{image.id}")
-      image.id
-    end
-
-    # Get droplet by its name
-    # @param [String] droplet_name
-    # @return [DropletKit::Droplet] droplet
-    def droplet_by_name(droplet_name)
-      assure_correct_token
-      droplets = @client.droplets.all
-      droplets.find { |x| x.name == droplet_name }
-    end
-
-    def get_droplet_id_by_name(droplet_name)
-      droplet = droplet_by_name(droplet_name)
-      if droplet.nil?
-        OnlyofficeLoggerHelper.log("get_droplet_id_by_name(#{droplet_name}): not found any droplets")
-        nil
-      else
-        OnlyofficeLoggerHelper.log("get_droplet_id_by_name(#{droplet_name}): #{droplet.id}")
-        droplet.id
-      end
-    end
-
-    def get_droplet_ip_by_name(droplet_name)
-      droplet = droplet_by_name(droplet_name)
-      if droplet.nil?
-        OnlyofficeLoggerHelper.log("There is no created droplet with name: #{droplet_name}")
-        return
-      end
-      ip = droplet.networks.first.first.ip_address
-      OnlyofficeLoggerHelper.log("get_droplet_ip_by_name(#{droplet_name}): #{ip}")
-      ip
-    end
-
     def current_kernel(droplet_name)
       droplet = droplet_by_name(droplet_name)
       kernel_name = droplet.kernel.name
@@ -80,21 +32,8 @@ module OnlyofficeDigitaloceanWrapper
       kernel_name
     end
 
-    def get_droplet_status_by_name(droplet_name)
-      droplet = droplet_by_name(droplet_name)
-      if droplet.nil?
-        OnlyofficeLoggerHelper.log("get_droplet_status_by_name(#{droplet_name}): not found any droplets")
-        nil
-      else
-        status = droplet.status
-        status = :locked if droplet.locked
-        OnlyofficeLoggerHelper.log("get_droplet_status_by_name(#{droplet_name}): #{status}")
-        status
-      end
-    end
-
-    def wait_until_droplet_have_status(droplet_name, status = 'active')
-      timeout = 300
+    def wait_until_droplet_have_status(droplet_name, status = 'active', params = {})
+      timeout = params.fetch(:timeout, 300)
       counter = 0
       while get_droplet_status_by_name(droplet_name) != status && counter < timeout
         counter += 10
@@ -102,6 +41,8 @@ module OnlyofficeDigitaloceanWrapper
         OnlyofficeLoggerHelper.log("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
+
       get_droplet_status_by_name(droplet_name)
     end
 
@@ -114,9 +55,13 @@ module OnlyofficeDigitaloceanWrapper
 
     def restore_image_by_name(image_name = 'nct-at-stable',
                               droplet_name = image_name,
-                              region = 'nyc2',
+                              region = 'nyc3',
                               size = '2gb',
                               tags: nil)
+      unless DROPLET_SIZES.include?(size)
+        raise DigitalOceanSizeNotSupported,
+              "There is no support of droplets with size: #{size}"
+      end
       image_id = get_image_id_by_name(image_name)
       droplet = DropletKit::Droplet.new(name: droplet_name,
                                         region: region,
@@ -132,39 +77,11 @@ module OnlyofficeDigitaloceanWrapper
       created
     end
 
-    def power_off_droplet(droplet_name)
-      droplet_id = get_droplet_id_by_name(droplet_name)
-      client.droplet_actions.power_off(droplet_id: droplet_id)
-      wait_until_droplet_have_status(droplet_name, 'off')
-    end
-
-    def power_on_droplet(droplet_name)
-      droplet_id = get_droplet_id_by_name(droplet_name)
-      client.droplet_actions.power_on(droplet_id: droplet_id)
-      wait_until_droplet_have_status(droplet_name)
-    end
-
-    def reboot_droplet(droplet_name)
-      droplet_id = get_droplet_id_by_name(droplet_name)
-      client.droplet_actions.reboot(droplet_id: droplet_id)
-      wait_until_droplet_have_status(droplet_name)
-    end
-
     def destroy_droplet_by_name(droplet_name = 'nct-at1')
       droplet_id = get_droplet_id_by_name(droplet_name)
       client.droplets.delete(id: droplet_id)
       OnlyofficeLoggerHelper.log("destroy_droplet_by_name(#{droplet_name})")
       wait_until_droplet_have_status(droplet_name, nil)
     end
-
-    # Read access token from file system
-    # @return [String] token
-    def self.read_token
-      return ENV['DO_ACCESS_TOKEN'] if ENV['DO_ACCESS_TOKEN']
-      File.read(Dir.home + '/.do/access_token').delete("\n")
-    rescue Errno::ENOENT
-      raise Errno::ENOENT, "No access token found in #{Dir.home}/.do/ directory." \
-      "Please create files #{Dir.home}/.do/access_token"
-    end
   end
 end

data/lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/digitalocean_exceptions.rb

@@ -1,5 +1,15 @@
+# frozen_string_literal: true
+
 module OnlyofficeDigitaloceanWrapper
   # Class raised if image with name is not found
   class DigitalOceanImageNotFound < StandardError
   end
+
+  # Class raised if droplet size is not supported
+  class DigitalOceanSizeNotSupported < StandardError
+  end
+
+  # Class raised if droplet opertaion is timeout
+  class DropletOperationTimeout < StandardError
+  end
 end

data/lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/exceptions_retryer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module OnlyofficeDigitaloceanWrapper
+  # Module to ignore DigitalOcean exception if they happen irregularly
+  module ExceptionsRetryer
+    # Retry if exception happened
+    # @param exception [Exception] exception to retry
+    # @param retries [Integer] how much to retry
+    # @param timeout [Integer] wait until next retry
+    def retry_exception(exception = DropletKit::Error,
+                        retries: 5,
+                        timeout: 10)
+      try = 0
+      begin
+        yield
+      rescue exception => e
+        try += 1
+        OnlyofficeLoggerHelper.log("Error '#{exception}, #{e}' happened during "\
+                                   "operation. Retrying #{try} of #{retries}")
+        sleep timeout # Time to cooldown error
+        try <= retries ? retry : raise
+      end
+    end
+  end
+end

data/lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/getters.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module OnlyofficeDigitaloceanWrapper
+  # Get image, droplet by metadata
+  module Getters
+    def get_image_id_by_name(image_name)
+      all_droplets = @client.images.all
+      image = all_droplets.find { |x| x.name == image_name }
+      raise DigitalOceanImageNotFound, image_name if image.nil?
+
+      OnlyofficeLoggerHelper.log("get_image_id_by_name(#{image_name}): #{image.id}")
+      image.id
+    end
+
+    # Get droplet by its name
+    # @param [String] droplet_name
+    # @return [DropletKit::Droplet] droplet
+    def droplet_by_name(droplet_name)
+      retry_exception do
+        droplets = @client.droplets.all
+        droplets.find { |x| x.name == droplet_name }
+      end
+    end
+
+    def get_droplet_id_by_name(droplet_name)
+      droplet = droplet_by_name(droplet_name)
+      if droplet.nil?
+        OnlyofficeLoggerHelper.log("get_droplet_id_by_name(#{droplet_name}): not found any droplets")
+        nil
+      else
+        OnlyofficeLoggerHelper.log("get_droplet_id_by_name(#{droplet_name}): #{droplet.id}")
+        droplet.id
+      end
+    end
+
+    def get_droplet_ip_by_name(droplet_name)
+      droplet = droplet_by_name(droplet_name)
+      if droplet.nil?
+        OnlyofficeLoggerHelper.log("There is no created droplet with name: #{droplet_name}")
+        return
+      end
+      retry_exception do
+        ip = droplet.networks.first.first.ip_address
+        OnlyofficeLoggerHelper.log("get_droplet_ip_by_name(#{droplet_name}): #{ip}")
+        ip
+      end
+    end
+
+    def get_droplet_status_by_name(droplet_name)
+      droplet = droplet_by_name(droplet_name)
+      if droplet.nil?
+        OnlyofficeLoggerHelper.log("get_droplet_status_by_name(#{droplet_name}): not found any droplets")
+        nil
+      else
+        retry_exception do
+          status = droplet.status
+          status = :locked if droplet.locked
+          OnlyofficeLoggerHelper.log("get_droplet_status_by_name(#{droplet_name}): #{status}")
+          status
+        end
+      end
+    end
+  end
+end

data/lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/power_actions.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module OnlyofficeDigitaloceanWrapper
+  # Actions with power (turn on/off, reboot)
+  module PowerActions
+    def power_off_droplet(droplet_name)
+      droplet_id = get_droplet_id_by_name(droplet_name)
+      client.droplet_actions.power_off(droplet_id: droplet_id)
+      wait_until_droplet_have_status(droplet_name, 'off')
+    end
+
+    def power_on_droplet(droplet_name)
+      droplet_id = get_droplet_id_by_name(droplet_name)
+      client.droplet_actions.power_on(droplet_id: droplet_id)
+      wait_until_droplet_have_status(droplet_name)
+    end
+
+    def reboot_droplet(droplet_name)
+      droplet_id = get_droplet_id_by_name(droplet_name)
+      client.droplet_actions.reboot(droplet_id: droplet_id)
+      wait_until_droplet_have_status(droplet_name)
+    end
+  end
+end

data/lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/token_methods.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module OnlyofficeDigitaloceanWrapper
+  # Methods to login in account
+  module TokenMethods
+    # Check if access token is correct
+    # @return [true, false] result of check
+    def correct_access_token?
+      begin
+        @client.droplets.all.first
+      rescue DropletKit::Error
+        return false
+      end
+      true
+    end
+
+    # Read access token from file system
+    # @return [String] token
+    def read_token
+      return ENV['DO_ACCESS_TOKEN'] if ENV['DO_ACCESS_TOKEN']
+
+      File.read(Dir.home + '/.do/access_token').delete("\n")
+    rescue Errno::ENOENT
+      raise Errno::ENOENT, "No access token found in #{Dir.home}/.do/ directory." \
+      "Please create files #{Dir.home}/.do/access_token"
+    end
+  end
+end

data/lib/onlyoffice_digitalocean_wrapper/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OnlyofficeDigitaloceanWrapper
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_digitalocean_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Pavel Lobashov
@@ -9,50 +9,36 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-05 00:00:00.000000000 Z
+date: 2020-02-27 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4'
 - !ruby/object:Gem::Dependency
   name: droplet_kit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.1
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: onlyoffice_logger_helper
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1'
 description: Wrapper gem for DigitalOcean. Use in testing projects
 email:
 - shockwavenn@gmail.com
@@ -65,6 +51,10 @@ files:
 - lib/onlyoffice_digitalocean_wrapper.rb
 - lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper.rb
 - 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/power_actions.rb
+- lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/token_methods.rb
 - lib/onlyoffice_digitalocean_wrapper/version.rb
 homepage: https://github.com/onlyoffice-testing-robot/onlyoffice_digitalocean_wrapper
 licenses:
@@ -78,15 +68,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Wrapper gem for DigitalOcean