sfrest 0.0.38 → 0.0.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7039e02a8fd620b58a601bdbca8cb00353ac78819593e4d45612e9ec93e3bd5d
-  data.tar.gz: 0b62f183dabf16e48091bc6aeaffbc938c0de3d2b0171f65d4230eac8139f71d
+  metadata.gz: 56ae7ea4f4d053d0263ad970320261fb9e2cea437d24b6785ddb5661d8b9a41a
+  data.tar.gz: 6c9eae93565ffa04bd0ba347838e51b2a33d7c4bececd1819265ea26d31a4d88
 SHA512:
-  metadata.gz: 352329ee8101653fc4d58943724590fbe91b7b8243d0d72e9e82a62683c3276824b91c64b1fe1f4a91551cfb3659bdd516aaf090de588e35651b19a549c87abd
-  data.tar.gz: 46e63d0eb317bac5bd088dcf5cd0ae3bb4ffd84c8f4d3aaed07b589a3ceb76d0b40502fa9e5e49d0c4553614d69838c5f56b10fe279ffab0ba7fd8582a492536
+  metadata.gz: b4677baf9be68f2c5d00b86d223ff79721eaae9d52446b0683bd55bc08cedfba094c6594a4b5cbf84bd44a90751851252c76b190d01341a60ee48f2d328db04c
+  data.tar.gz: d5feaaa64b0be6c1267b9eb5ec9d4d94690ab33c5a9e5d31f7c68ddc7c4300d7c766dbd5681527b2ccea255298d7580a3c79b7784ed66a5274f910e70f6a458d

data/lib/sfrest/connection.rb

@@ -169,14 +169,18 @@ module SFRest
                       collection
                       cron
                       domains
+                      factory_standard_domain
                       group
                       info
                       profile
                       role
                       site
+                      site_guard
                       site_ownership
+                      site_update_priority
                       stage
                       task
+                      task_log_settings
                       theme
                       update
                       usage

data/lib/sfrest/cron.rb

@@ -24,5 +24,58 @@ module SFRest
     def get_cron_job(nid)
       @conn.get("/api/v1/cronjobs/#{nid}")
     end
+
+    # Creates a new cron job
+    # @param [string] cron job name
+    # @param [string] cron job command
+    # @param [string] A unix cron expression
+    # @param [string] Sites affected by cron
+    # @param [int] if the cron should be enabled
+    # @param [int] The percentage of cron threads that should be used for this cron
+    # @param [array] An array of stack ids for which the cron should be enabled
+    # rubocop: disable Metrics/ParameterLists
+    def create_cron_job(name, command, interval, scope, enabled, thread_percentage, stacks)
+      # rubocop: enable Metrics/ParameterLists
+      payload = {
+        'name' => name,
+        'command' => command,
+        'interval' => interval,
+        'sites_affected' => scope,
+        'enabled' => enabled,
+        'thread_percentage' => thread_percentage,
+        'stacks' => stacks
+      }.to_json
+      @conn.post('/api/v1/cronjobs', payload)
+    end
+
+    # Edits a cron job by its node id
+    # @param [int] cron job nid
+    # @param [string] cron job name
+    # @param [string] cron job command
+    # @param [string] A unix cron expression
+    # @param [string] Sites affected by cron
+    # @param [int] if the cron should be enabled
+    # @param [int] The percentage of cron threads that should be used for this cron
+    # @param [array] An array of stack ids for which the cron should be enabled
+    # rubocop: disable Metrics/ParameterLists
+    def edit_cron_job(nid, name, command, interval, scope, enabled, thread_percentage, stacks)
+      # rubocop: enable Metrics/ParameterLists
+      payload = {
+        'name' => name,
+        'command' => command,
+        'interval' => interval,
+        'sites_affected' => scope,
+        'enabled' => enabled,
+        'thread_percentage' => thread_percentage,
+        'stacks' => stacks
+      }.to_json
+      @conn.put("/api/v1/cronjobs/#{nid}", payload)
+    end
+
+    # Deletes a cron job by its node id
+    # @param [int] cron job nid
+    def delete_cron_job(nid)
+      @conn.delete("/api/v1/cronjobs/#{nid}")
+    end
   end
 end

data/lib/sfrest/factory_standard_domain.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module SFRest
+  # We need to keep this naming due to the way connection.rb autoloads things.
+  # rubocop: disable Naming/ClassAndModuleCamelCase
+  # Manage the factory standard domain feature.
+  class Factory_standard_domain
+    # rubocop: enable Naming/ClassAndModuleCamelCase
+
+    # @param [SFRest::Connection] conn
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Get current factory standard domains settings
+    #
+    # @return [Array] an array of factory standard domains with their associated settings.
+    def factory_standard_domain_mapping
+      @conn.get('/api/v1/factory-standard-domains')
+    end
+
+    # Enable the factory standard domains settings for a given template name.
+    # @param [String] domain_template_name the domain template name.
+    # @param [Array] new_template the templates to be used.
+    #
+    # @return [Array] an array of factory standard domains with their associated settings.
+    def enable_factory_standard_domain_template(domain_template_name, new_template = [])
+      payload = {
+        'new_template' => new_template
+      }.to_json
+      @conn.put("/api/v1/factory-standard-domains/#{domain_template_name}", payload)
+    end
+
+    # Disable the centralized role management settings for a given role.
+    # @param [String] domain_template_name the domain template name.
+    #
+    # @return [Array] an array of factory standard domains with their associated settings.
+    def disable_factory_standard_domain_template(domain_template_name)
+      @conn.delete("/api/v1/factory-standard-domains/#{domain_template_name}")
+    end
+
+    # Backfills the factory standard domains using the templates defined.
+    #
+    # @return [Array] an array containing the message and task_id for that operation.
+    def backfill_domains
+      @conn.post('/api/v1/factory-standard-domains', {}.to_json)
+    end
+  end
+end

data/lib/sfrest/site_guard.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module SFRest
+  # We need to keep this naming due to the way connection.rb autoloads things.
+  # rubocop: disable Naming/ClassAndModuleCamelCase
+  # Manage the site guard feature.
+  class Site_guard
+    # rubocop: enable Naming/ClassAndModuleCamelCase
+
+    # @param [SFRest::Connection] conn
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Get current site guard settings.
+    #
+    # @return [Array] an array containing current settings.
+    def current_settings
+      @conn.get('/api/v1/site-guard')
+    end
+
+    # Set and enables the site guard settings.
+    # @param [String] The message which will be displayed by the site guard.
+    # @param [String] The username which will be required by the site guard.
+    # @param [String] The password which will be required by the site guard.
+    #
+    # @return [Array] an array containing the message given by the server.
+    def enable_site_guard(message, username, password)
+      payload = {
+        'message' => message,
+        'username' => username,
+        'password' => password
+      }
+
+      @conn.put('/api/v1/site-guard', payload.to_json)
+    end
+
+    # Removes and disableds the site guard settings.
+    #
+    # @return [Array] an array containing the message given by the server.
+    def disable_site_guard
+      @conn.delete('/api/v1/site-guard')
+    end
+  end
+end

data/lib/sfrest/site_ownership.rb

@@ -37,5 +37,35 @@ module SFRest
     def remove_default_owner
       @conn.delete('/api/v1/site-ownership')
     end
+
+    # Transfers site ownership using recipients username.
+    # @param [Integer] site id.
+    # @param [String] username.
+    # @param [Boolean] force_transfer.
+    #
+    # @return [Array] an array containing the message given by the server.
+    def transfer_site_ownership_using_username(site_id, username, force_transfer)
+      payload = {
+        'username' => username,
+        'force_transfer' => force_transfer
+      }
+
+      @conn.post("/api/v1/site-ownership/#{site_id}", payload.to_json)
+    end
+
+    # Transfers site ownership using recipients email.
+    # @param [Integer] site id.
+    # @param [String] email.
+    # @param [Boolean] force_transfer.
+    #
+    # @return [Array] an array containing the message given by the server.
+    def transfer_site_ownership_using_email(site_id, email, force_transfer)
+      payload = {
+        'email' => email,
+        'force_transfer' => force_transfer
+      }
+
+      @conn.post("/api/v1/site-ownership/#{site_id}", payload.to_json)
+    end
   end
 end

data/lib/sfrest/site_update_priority.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module SFRest
+  # We need to keep this naming due to the way connection.rb autoloads things.
+  # rubocop: disable Naming/ClassAndModuleCamelCase
+  # Manage the site update priority feature.
+  class Site_update_priority
+    # rubocop: enable Naming/ClassAndModuleCamelCase
+
+    # @param [SFRest::Connection] conn
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Get current site update priority.
+    #
+    # @return [Array] an array of the current site update priority.
+    def current_update_priority
+      @conn.get('/api/v1/site-update-priority')
+    end
+
+    # Set the site update priority list.
+    # @param [Array] site node ids in the desired update order.
+    #
+    # @return [Array] an array containing the message given by the server.
+    def change_update_priority(priority)
+      payload = {
+        'priority' => priority
+      }.to_json
+      @conn.put('/api/v1/site-update-priority', payload)
+    end
+
+    # Reset the site update priority to the default.
+    #
+    # @return [Array] an array containing the message given by the server.
+    def reset_update_priority
+      @conn.delete('/api/v1/site-update-priority')
+    end
+  end
+end

data/lib/sfrest/task_log_settings.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module SFRest
+  # We need to keep this naming due to the way connection.rb autoloads things.
+  # rubocop: disable Naming/ClassAndModuleCamelCase
+  # Manage the site default ownership feature.
+  class Task_log_settings
+    # rubocop: enable Naming/ClassAndModuleCamelCase
+
+    # @param [SFRest::Connection] conn
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Get current task log settings.
+    #
+    # @return [Array] an array containing current settings.
+    def current_task_log_settings
+      @conn.get('/api/v1/task-log-settings')
+    end
+
+    # Set the site ownership settings.
+    # @param [String] The maximum log level that will be written to the log.
+    # @param [String]  Level of Wip log messages to keep on successful completion.
+    #
+    # @return [Array] an array containing the message given by the server.
+    def edit_task_log_settings(wip_log_maximum_level, wip_log_level)
+      payload = {
+        'wip_log_maximum_level' => wip_log_maximum_level,
+        'wip_log_level' => wip_log_level
+      }
+
+      @conn.put('/api/v1/task-log-settings', payload.to_json)
+    end
+
+    # Reset current task log settings.
+    #
+    # @return [Array] an array containing the message given by the server.
+    def reset_task_log_settings
+      @conn.delete('/api/v1/task-log-settings')
+    end
+  end
+end

data/lib/sfrest/version.rb

@@ -2,5 +2,5 @@
 
 module SFRest
   # Just tracks the version of sfrest.
-  VERSION = '0.0.38'
+  VERSION = '0.0.41'
 end

data/lib/sfrest.rb

@@ -17,15 +17,19 @@ require 'sfrest/connection'
 require 'sfrest/cron'
 require 'sfrest/domains'
 require 'sfrest/error'
+require 'sfrest/factory_standard_domain'
 require 'sfrest/group'
 require 'sfrest/info'
 require 'sfrest/profile'
 require 'sfrest/pathbuilder'
 require 'sfrest/role'
 require 'sfrest/site'
+require 'sfrest/site_guard'
 require 'sfrest/site_ownership'
+require 'sfrest/site_update_priority'
 require 'sfrest/stage'
 require 'sfrest/task'
+require 'sfrest/task_log_settings'
 require 'sfrest/theme'
 require 'sfrest/update'
 require 'sfrest/usage'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sfrest
 version: !ruby/object:Gem::Version
-  version: 0.0.38
+  version: 0.0.41
 platform: ruby
 authors:
 - ACSF Engineering
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-11 00:00:00.000000000 Z
+date: 2022-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -110,15 +110,19 @@ files:
 - lib/sfrest/cron.rb
 - lib/sfrest/domains.rb
 - lib/sfrest/error.rb
+- lib/sfrest/factory_standard_domain.rb
 - lib/sfrest/group.rb
 - lib/sfrest/info.rb
 - lib/sfrest/pathbuilder.rb
 - lib/sfrest/profile.rb
 - lib/sfrest/role.rb
 - lib/sfrest/site.rb
+- lib/sfrest/site_guard.rb
 - lib/sfrest/site_ownership.rb
+- lib/sfrest/site_update_priority.rb
 - lib/sfrest/stage.rb
 - lib/sfrest/task.rb
+- lib/sfrest/task_log_settings.rb
 - lib/sfrest/theme.rb
 - lib/sfrest/update.rb
 - lib/sfrest/usage.rb
@@ -144,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.12
 signing_key:
 specification_version: 4
 summary: Acquia Site Factory Rest API.