onlyoffice_digitalocean_wrapper 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0756716e26a6789e98ffc4a22d58cb04587a93536680b183e600c233ae313dc8
-  data.tar.gz: de4e2ef86ffac922ad2c44d65e8034320db3f18137d2a64d491e7314cdcb9413
+  metadata.gz: ab5d384e54522d5e32c96089492303e10cd3243ed0f167d7fdbf4fd0a20b4786
+  data.tar.gz: 7df0fc6a8ff136cf2de91791e8301b3ab9acc2e8b05a0adfe9750b6979610a1a
 SHA512:
-  metadata.gz: 2d9c8941038d5e597f50fdce3d210f52d1902377b02e6c37c7b3f7fc6ac177de27d000f6da7edb28548d41029347694ada56467412746ac41a16368d1c892894
-  data.tar.gz: 101b02d252365ea34d1888e0452c7ce49bdf0e3f640e4566d322a52c28fe463b4af3e9b277a8266d7e111cc2c39dd7f4887c3b045b896f35c19ed1d579c2025b
+  metadata.gz: 406592b3cc7107311271454d6af88b98a5eda6cfd3edc18e50b2a6a6168ec72cf946d92398189588f6e9c1d734f8416fa6368f43dc02f16cf7d520f77d38b5dd
+  data.tar.gz: d3854132511ae1441671a5924655bd49898d415e19ad0d295257c043a861328e93201bae94d2737bef7d659b9ff15af7393fa8ef07065d423505e8ff4cbb37f2

data/lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper.rb

@@ -8,6 +8,7 @@ require_relative 'digitalocean_wrapper/getters'
 require_relative 'digitalocean_wrapper/power_actions'
 require_relative 'digitalocean_wrapper/token_methods'
 
+# Namespace for this gem
 module OnlyofficeDigitaloceanWrapper
   # Class for wrapping DigitalOcean API gem
   class DigitalOceanWrapper
@@ -16,6 +17,7 @@ module OnlyofficeDigitaloceanWrapper
     include PowerActions
     include TokenMethods
 
+    # @return [Array<String>] list of allowed droplet sizes
     DROPLET_SIZES = %w[512mb 1gb 2gb 4gb 8gb 16gb 32gb 48gb 64gb].freeze
     attr_accessor :client
 
@@ -25,6 +27,11 @@ module OnlyofficeDigitaloceanWrapper
       raise ArgumentError, 'DigitalOceanWrapper: Your Access Token is Incorrect' unless correct_access_token?
     end
 
+    # Wait until droplet has status
+    # @param droplet_name [String] name of droplet
+    # @param status [String] status to wait
+    # @param params [Hash] additiona params
+    # @return [Symbol] droplet status after wait over
     def wait_until_droplet_have_status(droplet_name, status = 'active', params = {})
       timeout = params.fetch(:timeout, 300)
       counter = 0
@@ -39,6 +46,13 @@ module OnlyofficeDigitaloceanWrapper
       get_droplet_status_by_name(droplet_name)
     end
 
+    # Restore droplet from image by name
+    # @param image_name [String] name of image
+    # @param droplet_name [String] name for droplet
+    # @param region [String] region to restore
+    # @param size [String] size of droplet
+    # @param tags [String, Array<String>] name of tags to apply
+    # @return [Object] object with droplet data
     def restore_image_by_name(image_name = 'nct-at-stable',
                               droplet_name = image_name,
                               region = 'nyc3',
@@ -64,6 +78,9 @@ module OnlyofficeDigitaloceanWrapper
       created
     end
 
+    # Destroy droplet by name
+    # @param droplet_name [String] name of droplet
+    # @return [Symbol] Droplet status after destruction
     def destroy_droplet_by_name(droplet_name = 'nct-at1')
       droplet_id = get_droplet_id_by_name(droplet_name)
       client.droplets.delete(id: droplet_id)

data/lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/getters.rb

@@ -22,6 +22,9 @@ module OnlyofficeDigitaloceanWrapper
       end
     end
 
+    # Return droplet id by it's name
+    # @param droplet_name [String] name of droplet
+    # @return [Integer] id of droplet
     def get_droplet_id_by_name(droplet_name)
       droplet = droplet_by_name(droplet_name)
       if droplet.nil?
@@ -33,6 +36,9 @@ module OnlyofficeDigitaloceanWrapper
       end
     end
 
+    # Return droplet ip by it's name
+    # @param droplet_name [String] name of droplet
+    # @return [String] ip of droplet
     def get_droplet_ip_by_name(droplet_name)
       droplet = droplet_by_name(droplet_name)
       if droplet.nil?
@@ -46,6 +52,9 @@ module OnlyofficeDigitaloceanWrapper
       end
     end
 
+    # Return droplet status by it's name
+    # @param droplet_name [String] name of droplet
+    # @return [Symbol] droplet status
     def get_droplet_status_by_name(droplet_name)
       droplet = droplet_by_name(droplet_name)
       if droplet.nil?
@@ -66,7 +75,7 @@ module OnlyofficeDigitaloceanWrapper
     # @return [String] public ip
     def public_ip(droplet)
       networks = droplet.networks.to_a.first
-      public_network = networks.find { |net| net.type == 'public'}
+      public_network = networks.find { |net| net.type == 'public' }
       public_network.ip_address
     end
   end

data/lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/power_actions.rb

@@ -3,18 +3,27 @@
 module OnlyofficeDigitaloceanWrapper
   # Actions with power (turn on/off, reboot)
   module PowerActions
+    # Turn off droplet
+    # @param droplet_name [String] droplet to turn off
+    # @return [Symbol] droplet result status
     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
 
+    # Turn on droplet
+    # @param droplet_name [String] droplet to turn on
+    # @return [Symbol] droplet result status
     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
 
+    # Reboot droplet
+    # @param droplet_name [String] droplet to reboot
+    # @return [Symbol] droplet result status
     def reboot_droplet(droplet_name)
       droplet_id = get_droplet_id_by_name(droplet_name)
       client.droplet_actions.reboot(droplet_id: droplet_id)

data/lib/onlyoffice_digitalocean_wrapper/digitalocean_wrapper/token_methods.rb

@@ -15,14 +15,17 @@ module OnlyofficeDigitaloceanWrapper
     end
 
     # Read access token from file system
+    # @param token_file_path [String] path to token
+    # @param force_file_read [True, False] should read from file be forced
     # @return [String] token
-    def read_token
-      return ENV['DO_ACCESS_TOKEN'] if ENV['DO_ACCESS_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
 
-      File.read(Dir.home + '/.do/access_token').delete("\n")
+      File.read(token_file_path).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"
+      raise Errno::ENOENT, "No access token found in #{token_file_path}. " \
+      "Please create file #{token_file_path} with token"
     end
   end
 end

data/lib/onlyoffice_digitalocean_wrapper/version.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module OnlyofficeDigitaloceanWrapper
-  VERSION = '0.4.1'
+  # @return [String] version of gem
+  VERSION = '0.5.0'
+  # @return [String] name of gem
   NAME = 'onlyoffice_digitalocean_wrapper'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: onlyoffice_digitalocean_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - ONLYOFFICE
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-05 00:00:00.000000000 Z
+date: 2020-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: droplet_kit
@@ -40,6 +40,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  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
@@ -54,6 +82,90 @@ dependencies:
     - - "~>"
       - !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
+  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: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !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
@@ -70,15 +182,15 @@ files:
 - 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
+homepage: https://github.com/ONLYOFFICE-QA/onlyoffice_digitalocean_wrapper
 licenses:
 - AGPL-3.0
 metadata:
-  bug_tracker_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_digitalocean_wrapper/issues
-  changelog_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_digitalocean_wrapper/blob/master/CHANGELOG.md
+  bug_tracker_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_digitalocean_wrapper/issues
+  changelog_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_digitalocean_wrapper/blob/master/CHANGELOG.md
   documentation_uri: https://www.rubydoc.info/gems/onlyoffice_digitalocean_wrapper
-  homepage_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_digitalocean_wrapper
-  source_code_uri: https://github.com/onlyoffice-testing-robot/onlyoffice_digitalocean_wrapper
+  homepage_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_digitalocean_wrapper
+  source_code_uri: https://github.com/ONLYOFFICE-QA/onlyoffice_digitalocean_wrapper
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -87,7 +199,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="