sfrest 0.0.24 → 0.0.25

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ee79c665b3444d5bd753652f9244ae3920cd8f9240cc9a628b883139ea18b40
-  data.tar.gz: 67a0c06a31049777e955259513c725f57a339af862f7dbecdec5146a7ac09ab1
+  metadata.gz: 454094d1aed9e441d633a8f69733518952f014a1aefa8246f5bf00cc659d4a34
+  data.tar.gz: 0de73fa9d7a32b350d78237e95b90630544952695b189d74576f6ef2c5f52107
 SHA512:
-  metadata.gz: 027e57b3b115f1af636acc5691a6bc68c7a44b666255104689c7b58b38a2cc99340bdd59b019263dcb36f56199fbcf4c69e67d7762c834adfc84c42060d4afc3
-  data.tar.gz: '0817a732028ef2d5fa907b3cc64b1babb0d9ea38b5a896277a167306c048f59898ec8714c39cd04e47d397e90233c319b911119a3e259985639d36533bbe53b8'
+  metadata.gz: 7bbc97856c5e30f44327d8c1cda39ed695e015b67afe5fcce668100c04b0ac9adb75f2a5c7254c978341d03342e298df039c4d2d4446cbebaa377e993b9981d4
+  data.tar.gz: 7dd69e1115edda16ec71d2a0954fc807364e4359c7f834a6c0cf8aae1709f41f31e24c57ba0f103a8dccf669c4fa51730fe6f82a07ea501636dc9528d354d43a

data/lib/sfrest/connection.rb

@@ -77,16 +77,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
 

data/lib/sfrest/group.rb

@@ -15,6 +15,22 @@ 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
@@ -23,6 +39,74 @@ module SFRest
       @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 }

data/lib/sfrest/version.rb

@@ -1,4 +1,4 @@
 module SFRest
   # Just tracks the version of sfrest.
-  VERSION = '0.0.24'.freeze
+  VERSION = '0.0.25'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sfrest
 version: !ruby/object:Gem::Version
-  version: 0.0.24
+  version: 0.0.25
 platform: ruby
 authors:
 - ACSF Engineering
@@ -140,7 +140,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Acquia Site Factory Rest API.