sfrest 0.0.40 → 0.0.43

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef1480dd089e071458111ef6c8f2ea4e0e4aa7ff7bfc509e2c150f33167f0e69
-  data.tar.gz: f90b9028fbf5e4b117d8856144d271516c5f4af6e9ae04800d55c1f1cc2c48db
+  metadata.gz: 072b940e3399ceb72f13d948ea766039eb4452c62925b1c2a1492072c5fb8557
+  data.tar.gz: 23e9bee2aefc2abce1b9aa86c0c99fee8fb3d7c4ca716b8957923f75ca0e0c5c
 SHA512:
-  metadata.gz: e940d9ece6a6ad534a9d3025e3dfe2aa56ef3026f74d7efbdaa84fe9add7d9b62831d68d87a0bf12b7e2ccb5d91ba19eeb6b3822ce23e82b992c15d7d531a166
-  data.tar.gz: b488d33656b6ebc149f35f488da4963c34994fe762482a08717ae78f783db9d9354663803b7a9eedc5773afeeb69ed153c54a4efe1f7c66d5b38fb715d15f25b
+  metadata.gz: f07d0676a52f33daf4d63564066fd3318ab25a11032d464444bc4111716b364618c71febb5ec948c073af6fc4b429baccc8ee7d3b3b01b0a67c165b08872e555
+  data.tar.gz: 5be39a40373a247f71142b07d942644a3c9469e312e1460e3dd4e449e346da69276a401c28dee62446bf46d69048391fa62848542311c9d5f3e5969085f13184

data/lib/sfrest/connection.rb

@@ -174,12 +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_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/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/update.rb

@@ -100,6 +100,22 @@ module SFRest
       @multi_stack ||= @conn.codebase.list['stacks'].size > 1
     end
 
+    # Terminates an updater.
+    def terminate_updater(update_id)
+      current_path = "/api/v1/update/#{update_id}"
+      @conn.delete(current_path)
+    end
+
+    # Changes the updater start time.
+    def change_updater_start_time(updater_id, new_update_time)
+      current_path = '/api/v1/update/change_time'
+      payload = {
+        'updater_id' => updater_id,
+        'new_update_time' => new_update_time
+      }.to_json
+      @conn.post(current_path, payload)
+    end
+
     # Determines if the v2 endpoint exists.
     # A factory with the endpoint will raise an SFRest::BadRequestError
     # A factory without the endpoint will raise SFRest::InvalidResponse

data/lib/sfrest/version.rb

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

data/lib/sfrest.rb

@@ -23,12 +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.40
+  version: 0.0.43
 platform: ruby
 authors:
 - ACSF Engineering
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-08 00:00:00.000000000 Z
+date: 2022-07-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -116,12 +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
@@ -147,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.