sfrest 0.0.34 → 0.0.38

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c59bfb1dd3ab6cde61f5db37e267d97824ceeea04f8306d25b083eadf394988
-  data.tar.gz: 6546e19cee41d06a5f44b2c09b6d8c3fb090730b78e8f712388dd05b039f6966
+  metadata.gz: 7039e02a8fd620b58a601bdbca8cb00353ac78819593e4d45612e9ec93e3bd5d
+  data.tar.gz: 0b62f183dabf16e48091bc6aeaffbc938c0de3d2b0171f65d4230eac8139f71d
 SHA512:
-  metadata.gz: 8eb3c3b56c037e6ab162d8ba7dfa939be6d8a5d5fe62124acbc1eae30259eb3a5fb5db5d129248870f91983b8badd8b0e5f0d4be8d62eec1126fcbc2588fbda3
-  data.tar.gz: d96ed66389ea837e2b293f041d68b4751ebeedd08f69e582921afac2d85b07c7c95fb1055e5fdcaa10e6c23a9e2a0951ef0ae347127d8704b0fb9fa91106f188
+  metadata.gz: 352329ee8101653fc4d58943724590fbe91b7b8243d0d72e9e82a62683c3276824b91c64b1fe1f4a91551cfb3659bdd516aaf090de588e35651b19a549c87abd
+  data.tar.gz: 46e63d0eb317bac5bd088dcf5cd0ae3bb4ffd84c8f4d3aaed07b589a3ceb76d0b40502fa9e5e49d0c4553614d69838c5f56b10fe279ffab0ba7fd8582a492536

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,17 @@ module SFRest
     # NOTE: accessor == Class_name.to_lower
     REST_METHODS = %w[audit
                       backup
+                      centralized_role_management
                       codebase
                       collection
+                      cron
                       domains
                       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/site.rb

@@ -55,20 +55,21 @@ module SFRest
       res['sites'].first['id']
     end
 
-    # Gets the complete list of sites
-    # Makes multiple requests to the factory to get all the sites on the factory
-    # @param [Boolean] show_incomplete whether to include incomplete sites in
-    #   the list. The default differs from UI/SF to maintain backward compatibility.
+    # Gets the complete list of sites.
+    #
+    # Makes multiple requests to the factory to get all the sites on the
+    # factory.
+    #
+    # @param [Hash] opts query parameters to be used in this request.
     # @return [Hash{'count' => Integer, 'sites' => Hash}]
-    # rubocop: disable Style/OptionalBooleanParameter
-    def site_list(show_incomplete = true)
+    def site_list(**opts)
       page = 1
       not_done = true
       count = 0
       sites = []
       while not_done
-        current_path = '/api/v1/sites?page='.dup << page.to_s
-        current_path <<= '&show_incomplete=true' if show_incomplete
+        opts['page'] = page
+        current_path = "/api/v1/sites?#{URI.encode_www_form(opts)}"
         res = @conn.get(current_path)
         if res['sites'] == []
           not_done = false
@@ -86,7 +87,6 @@ module SFRest
       end
       { 'count' => count, 'sites' => sites }
     end
-    # rubocop: enable Style/OptionalBooleanParameter
 
     # Creates a site.
     # @param [String] sitename The name of the site to create.

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

@@ -33,6 +33,8 @@ module SFRest
     # @param [Boolean] wipe_target_environment recreate the target stage wiping all data
     # @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
@@ -41,14 +43,18 @@ module SFRest
                        email_site_status: false,
                        wipe_target_environment: false,
                        synchronize_all_users: true,
-                       wipe_stacks: [])
+                       wipe_stacks: [],
+                       skip_site_files: false,
+                       skip_site_files_overwrite: [])
       raise InvalidApiVersion, staging_versions unless staging_versions.include? 2
 
       payload = { 'to_env' => env, 'sites' => sites,
                   'detailed_status' => email_site_status,
                   'wipe_target_environment' => wipe_target_environment,
                   'synchronize_all_users' => synchronize_all_users,
-                  'wipe_stacks' => wipe_stacks }.to_json
+                  'wipe_stacks' => wipe_stacks,
+                  '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.34'
+  VERSION = '0.0.38'
 end

data/lib/sfrest.rb

@@ -10,9 +10,11 @@ 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/group'
@@ -21,6 +23,7 @@ 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.34
+  version: 0.0.38
 platform: ruby
 authors:
 - ACSF Engineering
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-26 00:00:00.000000000 Z
+date: 2022-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -103,9 +103,11 @@ 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/group.rb
@@ -114,6 +116,7 @@ files:
 - 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
@@ -141,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.17
 signing_key:
 specification_version: 4
 summary: Acquia Site Factory Rest API.