sfrest 0.0.36 → 0.0.39

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22fe3070d6203957aa5361a2583ec43dc1f63f29c5bd8a08335e07c176d082d6
-  data.tar.gz: 4e0c7a0f06eaa5b72a215fcc1028f90eb9faf6a92394ad2b79a26728a1043af0
+  metadata.gz: 1e2e8fc07cf9577be1a4a1ccca84a3049b992e27e318a8b1d6d7fcd575f82fee
+  data.tar.gz: 4c234cc4ce912626b82c1899a139026c02c214176a83018118e57d0714ef2dc1
 SHA512:
-  metadata.gz: d9e8de406c5b8439f21974b2975f07898eed6789c33c1d8643f8a0d955a8eadb8b9b3768d59eb21834b3f247df4a4ba5dad2c5621737c6c16499a486c6d7a1cc
-  data.tar.gz: 91afd11ef8f8bb8cf8c219aeca3082542d5f66cf1e51a332e6dd8aa63661feafcc9b4f8e437d74d4468dab250d12fd7189fb6e95ea58db7f3a05fae520d494ad
+  metadata.gz: 60dc925219e31dce103270055b1dbf73285f4b6ee4a08d18f697603a4d85c17eeb04aeaf7c82c0155ceed9514867cb2a7830955632f7d08217070d4db2c0878b
+  data.tar.gz: 65076385c8d487c6adc87d1981bf8a39005f9208056b0733ec2a322d80949d2f46808833bd762309e0280f3b760c45c8898bf93d40e50c1fcca4b3b51eac896c

data/lib/sfrest/centralized_role_management.rb

@@ -0,0 +1,42 @@
+# 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 centralized role management feature.
+  class Centralized_role_management
+    # rubocop: enable Naming/ClassAndModuleCamelCase
+
+    # @param [SFRest::Connection] conn
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Get current centralized role management settings
+    #
+    # @return [Array] an array of roles with their associated settings.
+    def centralized_role_mapping
+      @conn.get('/api/v1/centralized-role-management')
+    end
+
+    # Enable the centralized role management settings for a given role.
+    # @param [String] factory_role the site factory role.
+    # @param [String] site_role the corresponding role on the site.
+    #
+    # @return [Array] an array of roles with their associated settings.
+    def enable_role_mapping(factory_role, site_role = '')
+      payload = {
+        'site_role' => site_role
+      }.to_json
+      @conn.put("/api/v1/centralized-role-management/#{factory_role}", payload)
+    end
+
+    # Disable the centralized role management settings for a given role.
+    # @param [String] factory_role the site factory role.
+    #
+    # @return [Array] an array of roles with their associated settings.
+    def disable_role_mapping(factory_role)
+      @conn.delete("/api/v1/centralized-role-management/#{factory_role}")
+    end
+  end
+end

data/lib/sfrest/connection.rb

@@ -164,14 +164,18 @@ module SFRest
     # NOTE: accessor == Class_name.to_lower
     REST_METHODS = %w[audit
                       backup
+                      centralized_role_management
                       codebase
                       collection
+                      cron
                       domains
+                      factory_standard_domain
                       group
                       info
                       profile
                       role
                       site
+                      site_ownership
                       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_ownership.rb

@@ -0,0 +1,41 @@
+# 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 Site_ownership
+    # rubocop: enable Naming/ClassAndModuleCamelCase
+
+    # @param [SFRest::Connection] conn
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Get current site ownership settings.
+    #
+    # @return [Array] an array containing current settings.
+    def default_ownership
+      @conn.get('/api/v1/site-ownership')
+    end
+
+    # Set the site ownership settings.
+    # @param [String] The default owner username. The user has to have the "Platform admin" role.
+    #
+    # @return [Array] an array containing the message given by the server.
+    def make_default_owner(username)
+      payload = {
+        'username' => username
+      }
+
+      @conn.put('/api/v1/site-ownership', payload.to_json)
+    end
+
+    # Removes the default site owner.
+    #
+    # @return [Array] an array containing the message given by the server.
+    def remove_default_owner
+      @conn.delete('/api/v1/site-ownership')
+    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.36'
+  VERSION = '0.0.39'
 end

data/lib/sfrest.rb

@@ -10,17 +10,21 @@ require 'json'
 
 require 'sfrest/audit'
 require 'sfrest/backup'
+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_ownership'
 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.36
+  version: 0.0.39
 platform: ruby
 authors:
 - ACSF Engineering
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -103,17 +103,21 @@ files:
 - lib/sfrest.rb
 - lib/sfrest/audit.rb
 - lib/sfrest/backup.rb
+- lib/sfrest/centralized_role_management.rb
 - 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_ownership.rb
 - lib/sfrest/stage.rb
 - lib/sfrest/task.rb
 - lib/sfrest/theme.rb