sfrest 0.0.33 → 0.0.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2f5b00dc3ae474b41cdc244d98db5f26a8cd87cfa4aca2ee342a1d0795c7c42
-  data.tar.gz: d33afbcae39304d25a89ecc3d23795d897373b8ef7e4c5b6b80c00f2b67f49da
+  metadata.gz: 573ae6cb7e5e7436c17d556e135ae412e91aececfdbe2b85a1dfa2ff813302df
+  data.tar.gz: 7ca7acc2ef22b1bf02bccb4ad19ea548d1d66756379d0882c488f9ac8bb3c2e7
 SHA512:
-  metadata.gz: a1d699a698c779fc0a2ac85652817bd5b25ffa356f091a4c48bf758ab24375df175a84c1bd0b88120bc7bbd2e2e5bc4495bab887cdbd23fd50e4cfe8085343a5
-  data.tar.gz: ed71ff4599ff3f459b5e0bde66c31bd0d54a6b0ee57edc83654eac666e72c13c405d9093b9000e6da32cbdfc4df8fb8807d3242bab1c0c9279620804df40b37a
+  metadata.gz: 886b5c70829c51516e3812c062188a52883541d922ad1bf9c952bb05093aa0b890616b5a6a5b3f4ed24604fd5d4b2551c803922773d826a1fd3a82e7e4583d6f
+  data.tar.gz: aaa80a02745ecc266300b76f37c6e0874adb2e9e2ca640ca94419f6fa48d23b64bb6eeab915a2dc4a6c2d8d21f6957014ed6c45c92e68bb0d919ddf17f57a8dc

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,13 +164,16 @@ module SFRest
     # NOTE: accessor == Class_name.to_lower
     REST_METHODS = %w[audit
                       backup
+                      centralized_role_management
                       codebase
                       collection
                       domains
                       group
                       info
+                      profile
                       role
                       site
+                      site_ownership
                       stage
                       task
                       theme

data/lib/sfrest/profile.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module SFRest
+  # Work with installation profiles.
+  class Profile
+    # @param [SFRest::Connection] conn
+    def initialize(conn)
+      @conn = conn
+    end
+
+    # Gets a list of installation profiles.
+    #
+    # @param [Hash] params Given as URL parameters.
+    # @option params [Integer] :stack_id A stack id to filter by.
+    # @option params [Boolean] :is_enabled True to filter by enabled profiles. False
+    #   to filter by disabled profiles.
+    # @return [Hash] Profile info formatted like so: {
+    #     'profiles' => [{
+    #       'name' => 'testing',
+    #       'description' => 'Some description',
+    #       'stack_id' => 1,
+    #       'rest_api_default' => false,
+    #       'enabled' => true
+    #     }],
+    #     'count' => 1,
+    #     'time' => '2021-03-12T02:26:34+00:00'
+    #   }
+    def profile_list(**params)
+      target_url = '/api/v1/profiles'
+      # Generate a string like "stack_id=3&is_enabled=true"
+      url_params = params.each.map { |k, v| "#{k}=#{v}" }.join('&')
+      target_url += "?#{url_params}" unless url_params.empty?
+
+      # Output is already well-formed, so return it.
+      @conn.get(target_url)
+    end
+
+    # Enables an installation profile.
+    #
+    # @param [String] name
+    # @param [Integer] stack_id Required if the factory is multistack.
+    def enable(name, stack_id: nil)
+      target_url = "/api/v1/profiles/#{name}/enable"
+      target_url += "?stack_id=#{stack_id}" unless stack_id.nil?
+      @conn.post(target_url, '{}')
+    end
+
+    # Disables an installation profile.
+    #
+    # @param [String] name
+    # @param [Integer] stack_id Required if the factory is multistack.
+    def disable(name, stack_id: nil)
+      target_url = "/api/v1/profiles/#{name}/disable"
+      target_url += "?stack_id=#{stack_id}" unless stack_id.nil?
+      @conn.post(target_url, '{}')
+    end
+
+    # Sets the default installation profile for use with other REST endpoints.
+    #
+    # @param [String] name
+    # @param [Integer] stack_id Required if the factory is multistack.
+    def set_default(name, stack_id: nil)
+      target_url = "/api/v1/profiles/#{name}/set_default"
+      target_url += "?stack_id=#{stack_id}" unless stack_id.nil?
+      @conn.post(target_url, '{}')
+    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,7 @@ 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
     #
     # @return [Integer] Id of the staging task created.
     # rubocop:disable Metrics/ParameterLists
@@ -41,14 +42,16 @@ module SFRest
                        email_site_status: false,
                        wipe_target_environment: false,
                        synchronize_all_users: true,
-                       wipe_stacks: [])
+                       wipe_stacks: [],
+                       skip_site_files: false)
       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 }.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.33'
+  VERSION = '0.0.37'
 end

data/lib/sfrest.rb

@@ -10,6 +10,7 @@ require 'json'
 
 require 'sfrest/audit'
 require 'sfrest/backup'
+require 'sfrest/centralized_role_management'
 require 'sfrest/codebase'
 require 'sfrest/collection'
 require 'sfrest/connection'
@@ -17,9 +18,11 @@ require 'sfrest/domains'
 require 'sfrest/error'
 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.33
+  version: 0.0.37
 platform: ruby
 authors:
 - ACSF Engineering
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2022-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -103,6 +103,7 @@ 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
@@ -111,8 +112,10 @@ files:
 - 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
@@ -140,7 +143,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.