sfrest 0.0.32 → 0.0.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 998c59d8ada04a4ea2af43ad2580cea0af6b16e1523868c060d0b6ba31c14ced
-  data.tar.gz: 225c6e090368da6504109a00a4a84d93bd0a8e7466a8fbed41c2bc9f48462f9f
+  metadata.gz: 22fe3070d6203957aa5361a2583ec43dc1f63f29c5bd8a08335e07c176d082d6
+  data.tar.gz: 4e0c7a0f06eaa5b72a215fcc1028f90eb9faf6a92394ad2b79a26728a1043af0
 SHA512:
-  metadata.gz: f9253037e192f7e8632b8ea431d490260f706cebdbb3fa4580effae8fab5539dc5054e0b0992a2da2b6531e38382e59818a334881badf087bac6a656ea0ac8e8
-  data.tar.gz: 5391b5f7d359e84a51de65898b08170197d0733f009f1997b1fe3265f9aaef3c72af92b364f5e8ff09d0776d362fd38b6d387d6a033a636414146eba614bbabe
+  metadata.gz: d9e8de406c5b8439f21974b2975f07898eed6789c33c1d8643f8a0d955a8eadb8b9b3768d59eb21834b3f247df4a4ba5dad2c5621737c6c16499a486c6d7a1cc
+  data.tar.gz: 91afd11ef8f8bb8cf8c219aeca3082542d5f66cf1e51a332e6dd8aa63661feafcc9b4f8e437d74d4468dab250d12fd7189fb6e95ea58db7f3a05fae520d494ad

data/lib/sfrest/connection.rb

@@ -169,6 +169,7 @@ module SFRest
                       domains
                       group
                       info
+                      profile
                       role
                       site
                       stage

data/lib/sfrest/group.rb

@@ -159,5 +159,13 @@ module SFRest
       end
       nil
     end
+
+    # Returns sites belonging to a specified group id.
+    # @param [Integer] group_id Id of the group to fetch
+    # @return [Hash] {'count' => count, 'sites' => Hash }
+    def sites(group_id = 0)
+      current_path = "/api/v1/groups/#{group_id}/sites"
+      @conn.get(current_path)
+    end
   end
 end

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/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.32'
+  VERSION = '0.0.36'
 end

data/lib/sfrest.rb

@@ -17,6 +17,7 @@ require 'sfrest/domains'
 require 'sfrest/error'
 require 'sfrest/group'
 require 'sfrest/info'
+require 'sfrest/profile'
 require 'sfrest/pathbuilder'
 require 'sfrest/role'
 require 'sfrest/site'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sfrest
 version: !ruby/object:Gem::Version
-  version: 0.0.32
+  version: 0.0.36
 platform: ruby
 authors:
 - ACSF Engineering
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-27 00:00:00.000000000 Z
+date: 2022-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -111,6 +111,7 @@ 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/stage.rb
@@ -140,7 +141,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.