sfrest 0.0.39 → 0.0.42

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e2e8fc07cf9577be1a4a1ccca84a3049b992e27e318a8b1d6d7fcd575f82fee
-  data.tar.gz: 4c234cc4ce912626b82c1899a139026c02c214176a83018118e57d0714ef2dc1
+  metadata.gz: 1aaa8110a7f4f77dbf3e382c6eab356eaba212ac1e7c781549701e06e1dcfd76
+  data.tar.gz: 4547d55501b96104f8db759ecff0164b8ed7f2fd3aba313fd79c13975c74e7ac
 SHA512:
-  metadata.gz: 60dc925219e31dce103270055b1dbf73285f4b6ee4a08d18f697603a4d85c17eeb04aeaf7c82c0155ceed9514867cb2a7830955632f7d08217070d4db2c0878b
-  data.tar.gz: 65076385c8d487c6adc87d1981bf8a39005f9208056b0733ec2a322d80949d2f46808833bd762309e0280f3b760c45c8898bf93d40e50c1fcca4b3b51eac896c
+  metadata.gz: 3fe6355a532f008da04903c25e27e7f6ddf28541bcd29768979178c3a0dce17b776fe17b8ced00e7f23c02e6d247a46fd4099a1ff412bbdfe951fe8ca3e0382d
+  data.tar.gz: 36de7a3762555fa9b6ca39f270f0cee99f95661ccc760738e4fd5ccd4668689890f8507abd85921c66fb27a686ffbebd8532d8bda18b0c96378a4697ff550afc

data/lib/sfrest/connection.rb

@@ -174,10 +174,14 @@ module SFRest
                       info
                       profile
                       role
+                      security_settings
                       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/security_settings.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 factory security settings.
+  class Security_settings
+    # rubocop: enable Naming/ClassAndModuleCamelCase
+
+    # @param [SFRest::Connection] conn
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Get current security settings.
+    #
+    # @return [Array] an array containing current security settings.
+    def current_security_settings
+      @conn.get('/api/v1/security')
+    end
+
+    # Change security settings.
+    #
+    # @param [Hash] data Options to the security settings
+    # @option data [Integer] 'minimum_password_length'
+    # @option data [String] 'minimum_required_password_strength'
+    # @option data [Boolean] 'two_step_verification'
+    # @option data [Boolean] 'sign_out_inactive_user_accounts'
+    # @option data [Integer] 'sign_out_inactivity_time'
+    # @option data [Boolean] 'automatically_disable_accounts'
+    # @option data [Integer] 'automatically_disable_accounts_after_days'
+    #
+    # @return [Array] an array containing the message given by the server.
+    def change_security_settings(data)
+      @conn.put('/api/v1/security', data.to_json)
+    end
+
+    # Reset current security settings.
+    #
+    # @return [Array] an array containing the message given by the server.
+    def reset_security_settings
+      @conn.delete('/api/v1/security')
+    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.39'
+  VERSION = '0.0.42'
 end

data/lib/sfrest.rb

@@ -23,10 +23,14 @@ require 'sfrest/info'
 require 'sfrest/profile'
 require 'sfrest/pathbuilder'
 require 'sfrest/role'
+require 'sfrest/security_settings'
 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.39
+  version: 0.0.42
 platform: ruby
 authors:
 - ACSF Engineering
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-25 00:00:00.000000000 Z
+date: 2022-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -116,10 +116,14 @@ files:
 - lib/sfrest/pathbuilder.rb
 - lib/sfrest/profile.rb
 - lib/sfrest/role.rb
+- lib/sfrest/security_settings.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
@@ -145,7 +149,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.