sfrest 0.0.37 → 0.0.40

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 573ae6cb7e5e7436c17d556e135ae412e91aececfdbe2b85a1dfa2ff813302df
-  data.tar.gz: 7ca7acc2ef22b1bf02bccb4ad19ea548d1d66756379d0882c488f9ac8bb3c2e7
+  metadata.gz: ef1480dd089e071458111ef6c8f2ea4e0e4aa7ff7bfc509e2c150f33167f0e69
+  data.tar.gz: f90b9028fbf5e4b117d8856144d271516c5f4af6e9ae04800d55c1f1cc2c48db
 SHA512:
-  metadata.gz: 886b5c70829c51516e3812c062188a52883541d922ad1bf9c952bb05093aa0b890616b5a6a5b3f4ed24604fd5d4b2551c803922773d826a1fd3a82e7e4583d6f
-  data.tar.gz: aaa80a02745ecc266300b76f37c6e0874adb2e9e2ca640ca94419f6fa48d23b64bb6eeab915a2dc4a6c2d8d21f6957014ed6c45c92e68bb0d919ddf17f57a8dc
+  metadata.gz: e940d9ece6a6ad534a9d3025e3dfe2aa56ef3026f74d7efbdaa84fe9add7d9b62831d68d87a0bf12b7e2ccb5d91ba19eeb6b3822ce23e82b992c15d7d531a166
+  data.tar.gz: b488d33656b6ebc149f35f488da4963c34994fe762482a08717ae78f783db9d9354663803b7a9eedc5773afeeb69ed153c54a4efe1f7c66d5b38fb715d15f25b

data/lib/sfrest/connection.rb

@@ -167,13 +167,17 @@ module SFRest
                       centralized_role_management
                       codebase
                       collection
+                      cron
                       domains
+                      factory_standard_domain
                       group
                       info
                       profile
                       role
                       site
+                      site_guard
                       site_ownership
+                      site_update_priority
                       stage
                       task
                       theme

data/lib/sfrest/cron.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module SFRest
+  # Manipulates SF cron jobs.
+  class Cron
+    # @param [SFRest::Connection] conn
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Gets a list of cron jobs
+    # @param [Integer] page
+    # @param [Integer] items per page
+    def get_cron_jobs(page = nil, limit = nil)
+      args = {}
+      args['page'] = page unless page.nil?
+      args['limit'] = limit unless limit.nil?
+      url = "/api/v1/cronjobs?#{args.map { |k, v| "#{k}=#{v}" }.join('&')}"
+      @conn.get(url)
+    end
+
+    # Gets a cron job by its node id
+    # @param [Integer] cron job nid
+    def get_cron_job(nid)
+      @conn.get("/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_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/stage.rb

@@ -34,6 +34,7 @@ module SFRest
     # @param [synchronize_all_users] only stage the user accounts required for the related collections and groups
     # @param [Array] Stacks Array of stack ids to wipe
     # @param [Boolean] skip_site_files site skip file transfer during staging
+    # @param [Array] skip_site_files_overwrite list of files to skip during staging
     #
     # @return [Integer] Id of the staging task created.
     # rubocop:disable Metrics/ParameterLists
@@ -43,7 +44,8 @@ module SFRest
                        wipe_target_environment: false,
                        synchronize_all_users: true,
                        wipe_stacks: [],
-                       skip_site_files: false)
+                       skip_site_files: false,
+                       skip_site_files_overwrite: [])
       raise InvalidApiVersion, staging_versions unless staging_versions.include? 2
 
       payload = { 'to_env' => env, 'sites' => sites,
@@ -51,7 +53,8 @@ module SFRest
                   'wipe_target_environment' => wipe_target_environment,
                   'synchronize_all_users' => synchronize_all_users,
                   'wipe_stacks' => wipe_stacks,
-                  'skip_site_files' => skip_site_files }.to_json
+                  'skip_site_files' => skip_site_files,
+                  'skip_site_files_overwrite' => skip_site_files_overwrite }.to_json
       @conn.post('/api/v2/stage', payload)
     end
     # rubocop:enable Metrics/ParameterLists

data/lib/sfrest/version.rb

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

data/lib/sfrest.rb

@@ -14,15 +14,19 @@ require 'sfrest/centralized_role_management'
 require 'sfrest/codebase'
 require 'sfrest/collection'
 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/theme'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sfrest
 version: !ruby/object:Gem::Version
-  version: 0.0.37
+  version: 0.0.40
 platform: ruby
 authors:
 - ACSF Engineering
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-28 00:00:00.000000000 Z
+date: 2022-04-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -107,15 +107,19 @@ files:
 - lib/sfrest/codebase.rb
 - lib/sfrest/collection.rb
 - lib/sfrest/connection.rb
+- 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/theme.rb