sfrest 0.0.24 → 0.0.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ee79c665b3444d5bd753652f9244ae3920cd8f9240cc9a628b883139ea18b40
-  data.tar.gz: 67a0c06a31049777e955259513c725f57a339af862f7dbecdec5146a7ac09ab1
+  metadata.gz: 2c294e5ab1ba9e6a0a6be84b0c222ca5beae8326438db8c16dbee4a68d189599
+  data.tar.gz: ce5a155559c66f8b7831a7cb14964fc2ca4ca2465492bdfa479fdd22defc5bb9
 SHA512:
-  metadata.gz: 027e57b3b115f1af636acc5691a6bc68c7a44b666255104689c7b58b38a2cc99340bdd59b019263dcb36f56199fbcf4c69e67d7762c834adfc84c42060d4afc3
-  data.tar.gz: '0817a732028ef2d5fa907b3cc64b1babb0d9ea38b5a896277a167306c048f59898ec8714c39cd04e47d397e90233c319b911119a3e259985639d36533bbe53b8'
+  metadata.gz: edbdd8905bcc0ce249042f77e0e04a797ca852933adb4c9c546e83ad329f67711ce3ba2311650e44ea9a08b891f82b6f2e01e2052b3b9c1b65458f14e74d2d8a
+  data.tar.gz: 03e34c3a38581414209a546cdd0da6f6b9ee17c64f65539f6984f92e5ee7b4ae8d44dbe5552db5fbdce9a741607fdb4eec51c6f49c4bbad2a788246decdb70d1

data/lib/sfrest.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Simple wrappper around RestClient.Resource
 $LOAD_PATH.unshift(__dir__) unless
     $LOAD_PATH.include?(__dir__) ||

data/lib/sfrest/audit.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SFRest
   # Get all the audit devents.
   class Audit

data/lib/sfrest/backup.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SFRest
   # Backup a site or restore onto that site
   class Backup

data/lib/sfrest/codebase.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SFRest
   # List codebases on the factory.
   class Codebase

data/lib/sfrest/collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SFRest
   # Find colletions, return their data.
   class Collection
@@ -61,7 +63,7 @@ module SFRest
       not_done = true
       count = 0
       while not_done
-        current_path = '/api/v1/collections?page=' << page.to_s
+        current_path = '/api/v1/collections?page='.dup << page.to_s
         res = @conn.get(current_path)
         if res['collections'] == []
           not_done = false

data/lib/sfrest/connection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SFRest
   # Generic http methods
   # accessors for all the sub classes.
@@ -77,16 +79,18 @@ module SFRest
 
     # http request via delete
     # @param [string] uri
+    # @param [string] payload - This string will be supplied in the body of the request, similar to POST.
     # @return [Object] ruby representation of the json response
     #                  if the reponse body  does not parse, raises
     #                  a SFRest::InvalidResponse
-    def delete(uri)
+    def delete(uri, payload = '')
       headers = { 'Content-Type' => 'application/json' }
       res = Excon.delete(@base_url + uri.to_s,
                          headers: headers,
                          user: username,
                          password: password,
-                         ssl_verify_peer: false)
+                         ssl_verify_peer: false,
+                         body: payload)
       api_response res
     end
 
@@ -177,8 +181,8 @@ module SFRest
 
     REST_METHODS.each do |m|
       define_method(m) do
-        m.capitalize!
-        sfrest_klass = "SFRest::#{m}"
+        klazz = m.dup.capitalize!
+        sfrest_klass = "SFRest::#{klazz}"
         Object.const_get(sfrest_klass).new(self)
       end
     end

data/lib/sfrest/domains.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SFRest
   # Find Staging envs and stage a set of sites
   class Domains

data/lib/sfrest/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SFRest
   # Error classes for SFRest
 

data/lib/sfrest/group.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SFRest
   # SF Group management
   class Group
@@ -15,14 +17,98 @@ module SFRest
       @conn.post(current_path, payload)
     end
 
+    # Deletes the group with the specified id
+    # @param [Integer] group_id Id of the group to fetch
+    def delete_group(group_id)
+      current_path = '/api/v1/groups/' + group_id.to_s
+      @conn.delete(current_path)
+    end
+
+    # Renames existing group.
+    # @param [Integer] group_id Id of the group to rename.
+    # @param [String] groupname New name for the group.
+    def rename_group(group_id, groupname)
+      current_path = '/api/v1/groups/' + group_id.to_s + '/update'
+      payload = { 'group_name' => groupname }.to_json
+      @conn.put(current_path, payload)
+    end
+
     # Gets a site group with a specified group id.
     # @param [Integer] group_id Id of the group to fetch
     # @return [Hash] group object from the SF Api
     def get_group(group_id = 0)
-      current_path = '/api/v1/groups/' << group_id.to_s
+      current_path = '/api/v1/groups/' + group_id.to_s
+      @conn.get(current_path)
+    end
+
+    # Gets all users that are members of this group
+    # @param [Integer] group_id Id of the group to fetch
+    # @return [Hash] {'count' => count, 'members' => Hash }
+    def get_members(group_id = 0)
+      current_path = '/api/v1/groups/' + group_id.to_s + '/members'
       @conn.get(current_path)
     end
 
+    # Add users to this group
+    # @param [Integer] group_id Id of the group
+    # @param [Array] uids of the users that need to be added
+    # @return [Hash] {'count' => count, 'uids_added' => Hash }
+    def add_members(group_id, uids)
+      current_path = '/api/v1/groups/' + group_id.to_s + '/members'
+      payload = { 'uids' => uids.map(&:to_i) }.to_json
+      @conn.post(current_path, payload)
+    end
+
+    # Remove members from this group
+    # @param [Integer] group_id Id of the group
+    # @param [Array] uids of the users that need to be removed
+    # @return [Hash] {'group_id' => 123, 'uids_removed' => [1, 2, ...]}
+    def remove_members(group_id, uids)
+      current_path = '/api/v1/groups/' + group_id.to_s + '/members'
+      payload = { 'uids' => uids.map(&:to_i) }.to_json
+      @conn.delete(current_path, payload)
+    end
+
+    # Promote users to group admins
+    # @param [Integer] group_id Id of the group
+    # @param [Array] uids of the users that need to be promoted
+    # @return [Hash] {'count' => count, 'uids_promoted' => [1, 2, ...] }
+    def promote_to_admins(group_id, uids)
+      current_path = '/api/v1/groups/' + group_id.to_s + '/admins'
+      payload = { 'uids' => uids.map(&:to_i) }.to_json
+      @conn.post(current_path, payload)
+    end
+
+    # Demote users from group admins
+    # @param [Integer] group_id Id of the group
+    # @param [Array] uids of the users that need to be demoted
+    # @return [Hash] {'count' => count, 'uids_demoted' => Hash }
+    def demote_from_admins(group_id, uids)
+      current_path = '/api/v1/groups/' + group_id.to_s + '/admins'
+      payload = { 'uids' => uids.map(&:to_i) }.to_json
+      @conn.delete(current_path, payload)
+    end
+
+    # Add sites to this group
+    # @param [Integer] group_id Id of the group
+    # @param [Array] site_ids Ids of the sites that need to be added
+    # @return [Hash] {'group_id' => 123, 'site_ids_added' => [1, 2, ...]}
+    def add_sites(group_id, site_ids)
+      current_path = '/api/v1/groups/' + group_id.to_s + '/sites'
+      payload = { 'site_ids' => site_ids }.to_json
+      @conn.post(current_path, payload)
+    end
+
+    # Remove sites from this group
+    # @param [Integer] group_id Id of the group
+    # @param [Array] site_ids Ids of the sites that need to be removed.
+    # @return [Hash] {'group_id' => 123, 'site_ids_removed' => [1, 2, ...], 'site_ids_failed' => [3, 4, ...]}
+    def remove_sites(group_id, site_ids)
+      current_path = '/api/v1/groups/' + group_id.to_s + '/sites'
+      payload = { 'site_ids' => site_ids }.to_json
+      @conn.delete(current_path, payload)
+    end
+
     # Gets a list of all site groups.
     # @return [Hash] all the groups on the factory plus a count
     #                {'count' => count, 'groups' => Hash }
@@ -32,7 +118,7 @@ module SFRest
       not_done = true
       count = 0
       while not_done
-        current_path = '/api/v1/groups?page=' << page.to_s
+        current_path = '/api/v1/groups?page='.dup << page.to_s
         res = @conn.get(current_path)
         if res['groups'] == []
           not_done = false
@@ -50,5 +136,28 @@ module SFRest
       end
       { 'count' => count, 'groups' => groups }
     end
+
+    # gets the group ID for the group named groupname
+    # will page through all the groups available searching for the group
+    # @param [String] group the name of the group
+    # @return [Integer] the id of groupname
+    def get_group_id(groupname)
+      res = group_list
+      id = group_data_from_results(res, groupname, 'group_id')
+      return id if id
+    end
+
+    # Extract the group data for 'key' based on the site result object
+    # @param [Hash] res result from a request to /sites
+    # @param [String] groupname
+    # @param [String] key one of the user data returned (id, site, domain...)
+    # @return [Object] Integer, String, Array, Hash depending on the site data
+    def group_data_from_results(res, groupname, key)
+      groups = res['groups']
+      groups.each do |group|
+        return group[key] if group['group_name'] == groupname
+      end
+      nil
+    end
   end
 end

data/lib/sfrest/info.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SFRest
   # Retrieve Site Factory info.
   class Info

data/lib/sfrest/pathbuilder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SFRest
   # make a url querypath
   # so that if the are multiple items in a get request

data/lib/sfrest/role.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SFRest
   # create, delete, update, roles
   class Role
@@ -16,7 +18,7 @@ module SFRest
       not_done = true
       count = 0
       while not_done
-        current_path = '/api/v1/roles?page=' << page.to_s
+        current_path = '/api/v1/roles?page='.dup << page.to_s
         res = @conn.get(current_path)
         if res['roles'] == []
           not_done = false

data/lib/sfrest/site.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SFRest
   # Find sites, create a site,
   class Site
@@ -64,7 +66,7 @@ module SFRest
       count = 0
       sites = []
       while not_done
-        current_path = '/api/v1/sites?page=' << page.to_s
+        current_path = '/api/v1/sites?page='.dup << page.to_s
         current_path <<= '&show_incomplete=true' if show_incomplete
         res = @conn.get(current_path)
         if res['sites'] == []

data/lib/sfrest/stage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SFRest
   # Find Staging envs and stage a set of sites
   class Stage
@@ -28,21 +30,26 @@ module SFRest
     # @param [Boolean] email_site_status send an email about the staging status of each site
     # @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
     #
     # @return [Integer] Id of the staging task created.
+    # rubocop:disable Metrics/ParameterLists
     def enhanced_stage(env: 'test',
                        sites: nil,
                        email_site_status: false,
                        wipe_target_environment: false,
-                       synchronize_all_users: true)
+                       synchronize_all_users: true,
+                       wipe_stacks: nil)
       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 }.to_json
+                  'synchronize_all_users' => synchronize_all_users,
+                  'wipe_stacks' => wipe_stacks }.to_json
       @conn.post('/api/v2/stage', payload)
     end
+    # rubocop:enable Metrics/ParameterLists
 
     # Query for available staging environments
     #

data/lib/sfrest/task.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SFRest
   # Deal with tasks, find them, pause them...
   class Task
@@ -23,7 +25,7 @@ module SFRest
     # @param [Integer] status
     # @return [Boolean]
     def status_not_started?(status)
-      return true if (status.to_i & STATUS_TO_BE_RUN) > 0
+      return true if (status.to_i & STATUS_TO_BE_RUN).positive?
 
       false
     end
@@ -42,7 +44,7 @@ module SFRest
     # @param [Integer] status
     # @return [Boolean]
     def status_running?(status)
-      return true if (status.to_i & STATUS_RUNNING) > 0
+      return true if (status.to_i & STATUS_RUNNING).positive?
 
       false
     end
@@ -70,7 +72,7 @@ module SFRest
     # @param [Integer] status
     # @return [Boolean]
     def status_done?(status)
-      return true if (status.to_i & STATUS_DONE) > 0
+      return true if (status.to_i & STATUS_DONE).positive?
 
       false
     end
@@ -207,7 +209,7 @@ module SFRest
     # Get a specific task's logs
     # @param [Integer] task_id
     def get_task_logs(task_id)
-      current_path = '/api/v1/tasks/' << task_id.to_s << '/logs'
+      current_path = '/api/v1/tasks/' + task_id.to_s + '/logs'
       @conn.get(current_path)
     end
 
@@ -220,8 +222,8 @@ module SFRest
       begin
         res = @conn.get(current_path)
         paused = res['wip_pause_global']
-      rescue SFRest::SFError => error
-        paused = false if error.message =~ /Variable not found/
+      rescue SFRest::SFError => e
+        paused = false if e.message =~ /Variable not found/
       end
       paused
     end
@@ -231,7 +233,7 @@ module SFRest
     # @param [Integer] task_id
     # @param [String] level family|task
     def pause_task(task_id, level = 'family')
-      current_path = '/api/v1/pause/' << task_id.to_s
+      current_path = '/api/v1/pause/' + task_id.to_s
       payload = { 'paused' => true, 'level' => level }.to_json
       @conn.post(current_path, payload)
     end
@@ -241,7 +243,7 @@ module SFRest
     # @param [Integer] task_id
     # @param [String] level family|task
     def resume_task(task_id, level = 'family')
-      current_path = '/api/v1/pause/' << task_id.to_s
+      current_path = '/api/v1/pause/' + task_id.to_s
       payload = { 'paused' => false, 'level' => level }.to_json
       @conn.post(current_path, payload)
     end
@@ -259,7 +261,7 @@ module SFRest
     # This will delete the task and its children
     # @param [Integer] task_id
     def delete_task(task_id)
-      current_path = '/api/v1/tasks/' << task_id.to_s
+      current_path = '/api/v1/tasks/' + task_id.to_s
       @conn.delete(current_path)
     end
 
@@ -267,7 +269,7 @@ module SFRest
     # @param [String] type softpaused | softpause-for-update
     # @return [Array] Array of wip classes
     def get_task_class_info(type = '')
-      current_path = '/api/v1/classes/' << type
+      current_path = '/api/v1/classes/' + type
       @conn.get(current_path)
     end
 

data/lib/sfrest/theme.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SFRest
   # Tell the Factory that there is theme work to do
   class Theme

data/lib/sfrest/update.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SFRest
   # Drive updates on the Site Factory
   class Update
@@ -24,7 +26,7 @@ module SFRest
 
     # Lists vcs refs.
     def list_vcs_refs(type = 'sites', stack_id = 1)
-      current_path = '/api/v1/vcs?type=' << type << '&stack_id=' << stack_id.to_s
+      current_path = '/api/v1/vcs?type=' + type + '&stack_id=' + stack_id.to_s
       @conn.get(current_path)
     end
 

data/lib/sfrest/usage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SFRest
   # Get all the audit devents.
   class Usage

data/lib/sfrest/user.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SFRest
   # Do User actions within the Site Factory
   class User
@@ -14,7 +16,7 @@ module SFRest
       not_done = true
       count = 0
       while not_done
-        current_path = '/api/v1/users?page=' << page.to_s
+        current_path = '/api/v1/users?page=' + page.to_s
         res = @conn.get(current_path)
         if res['users'] == []
           not_done = false

data/lib/sfrest/variable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SFRest
   # Perform actions against variables in the Factory
   class Variable
@@ -14,7 +16,7 @@ module SFRest
 
     # Gets the value of a specific variable.
     def get_variable(name)
-      current_path = '/api/v1/variables?name=' << name
+      current_path = '/api/v1/variables?name=' + name
       @conn.get(current_path)
     end
 

data/lib/sfrest/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module SFRest
   # Just tracks the version of sfrest.
-  VERSION = '0.0.24'.freeze
+  VERSION = '0.0.29'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sfrest
 version: !ruby/object:Gem::Version
-  version: 0.0.24
+  version: 0.0.29
 platform: ruby
 authors:
 - ACSF Engineering
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-20 00:00:00.000000000 Z
+date: 2019-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.24'
 description: Wrapper methods around the ACSF Rest API.
-email: 
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -125,7 +125,7 @@ homepage: http://github.com/acquia/sf-sdk-ruby
 licenses:
 - APACHE-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -140,8 +140,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Acquia Site Factory Rest API.
 test_files: []