sfrest 0.0.28 → 0.0.33

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83313c2875ae8b2e25893b43d5047f6caad4907e39c5e2020aa2d4cec10b2ff5
-  data.tar.gz: 3cedc3b559dcd6544e299b02f483603e96f27c044dc0e8d178605f6a9ab23542
+  metadata.gz: a2f5b00dc3ae474b41cdc244d98db5f26a8cd87cfa4aca2ee342a1d0795c7c42
+  data.tar.gz: d33afbcae39304d25a89ecc3d23795d897373b8ef7e4c5b6b80c00f2b67f49da
 SHA512:
-  metadata.gz: 5f65fe32434ad90852cf50f259b1753de1f43c6be9d280a3ebe931a6f783a2a971954ce762c0d52a3a392a68bb9c72d05b7e8a3195423762d3c27148db202022
-  data.tar.gz: b4616fb5bb37170bbdb5bcec324f0d856f73d01839cf2f920d6d5c1d1d3c45157c9f60219527f0a15782fc8bdfd5f7fbf545276a2ee2123ecb375cde400a5795
+  metadata.gz: a1d699a698c779fc0a2ac85652817bd5b25ffa356f091a4c48bf758ab24375df175a84c1bd0b88120bc7bbd2e2e5bc4495bab887cdbd23fd50e4cfe8085343a5
+  data.tar.gz: ed71ff4599ff3f459b5e0bde66c31bd0d54a6b0ee57edc83654eac666e72c13c405d9093b9000e6da32cbdfc4df8fb8807d3242bab1c0c9279620804df40b37a

data/lib/sfrest/collection.rb

@@ -14,14 +14,14 @@ module SFRest
     # @return [Integer] the id of sitename
     def get_collection_id(name)
       pglimit = 100
-      res = @conn.get('/api/v1/collections&limit=' + pglimit.to_s)
+      res = @conn.get("/api/v1/collections&limit=#{pglimit}")
       count = res['count'].to_i
       id = collection_data_from_results(res, name, 'id')
       return id if id
 
       pages = (count / pglimit) + 1
       2.upto(pages) do |i|
-        res = @conn.get('/api/v1/collections&limit=' + pglimit.to_s + '?page=' + i.to_s)
+        res = @conn.get("/api/v1/collections&limit=#{pglimit}?page=#{i}")
         id = collection_data_from_results(res, name, 'id')
         return id if id
       end
@@ -45,7 +45,7 @@ module SFRest
     # @param [Integer] id the site id
     # @return [Hash]
     def get_collection_data(id)
-      @conn.get('/api/v1/collections/' + id.to_s)
+      @conn.get("/api/v1/collections/#{id}")
     end
 
     # gets the site id of the 1st one found using the api

data/lib/sfrest/connection.rb

@@ -42,7 +42,7 @@ module SFRest
                       user: username,
                       password: password,
                       ssl_verify_peer: false)
-      api_response res, true
+      api_response res, return_status: true
     end
 
     # http request via post
@@ -100,7 +100,7 @@ module SFRest
     #                  with the reponse
     # @return [Array|Object] if return_status then [int, Object]
     #                        else Object
-    def api_response(res, return_status = false)
+    def api_response(res, return_status: false)
       data = access_check JSON(res.body), res.status
       return_status ? [res.status, data] : data
     rescue JSON::ParserError

data/lib/sfrest/domains.rb

@@ -61,5 +61,22 @@ module SFRest
       payload = { 'domain_name' => domain_name }.to_json
       @conn.post("/api/v1/domains/#{node_id}/remove", payload)
     end
+
+    # Get domain status
+    # @param [String] domain_name domain to remove. e.g. www.example.com
+    #
+    # @return [Hash] {  "message" => "The domain is associated with the node.",
+    #   "is_domain_associated" => TRUE,
+    #   "node_id" => 123,
+    #   "node_type" => "site",
+    #   "time" => "2016-10-28T09:25:26+00:00",
+    #   "stack_id" => 1,
+    #   "domains" => array(
+    #      "protected_domains" => array('site.example.sfdev.acquia-test.co'),
+    #       "custom_domains" => array('www.abc.com/def', 'www.xyz.com'),
+    #   ) }
+    def status(domain_name)
+      @conn.get("/api/v1/domains/status/#{domain_name}")
+    end
   end
 end

data/lib/sfrest/group.rb

@@ -20,7 +20,7 @@ module SFRest
     # 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
+      current_path = "/api/v1/groups/#{group_id}"
       @conn.delete(current_path)
     end
 
@@ -28,7 +28,7 @@ module SFRest
     # @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'
+      current_path = "/api/v1/groups/#{group_id}/update"
       payload = { 'group_name' => groupname }.to_json
       @conn.put(current_path, payload)
     end
@@ -37,7 +37,7 @@ module SFRest
     # @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}"
       @conn.get(current_path)
     end
 
@@ -45,7 +45,7 @@ module SFRest
     # @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'
+      current_path = "/api/v1/groups/#{group_id}/members"
       @conn.get(current_path)
     end
 
@@ -54,7 +54,7 @@ module SFRest
     # @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'
+      current_path = "/api/v1/groups/#{group_id}/members"
       payload = { 'uids' => uids.map(&:to_i) }.to_json
       @conn.post(current_path, payload)
     end
@@ -64,7 +64,7 @@ module SFRest
     # @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'
+      current_path = "/api/v1/groups/#{group_id}/members"
       payload = { 'uids' => uids.map(&:to_i) }.to_json
       @conn.delete(current_path, payload)
     end
@@ -74,7 +74,7 @@ module SFRest
     # @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'
+      current_path = "/api/v1/groups/#{group_id}/admins"
       payload = { 'uids' => uids.map(&:to_i) }.to_json
       @conn.post(current_path, payload)
     end
@@ -84,7 +84,7 @@ module SFRest
     # @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'
+      current_path = "/api/v1/groups/#{group_id}/admins"
       payload = { 'uids' => uids.map(&:to_i) }.to_json
       @conn.delete(current_path, payload)
     end
@@ -94,7 +94,7 @@ module SFRest
     # @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'
+      current_path = "/api/v1/groups/#{group_id}/sites"
       payload = { 'site_ids' => site_ids }.to_json
       @conn.post(current_path, payload)
     end
@@ -104,7 +104,7 @@ module SFRest
     # @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'
+      current_path = "/api/v1/groups/#{group_id}/sites"
       payload = { 'site_ids' => site_ids }.to_json
       @conn.delete(current_path, payload)
     end
@@ -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/role.rb

@@ -44,14 +44,14 @@ module SFRest
     # this will iterate through the roles pages
     def get_role_id(rolename)
       pglimit = 100
-      res = @conn.get('/api/v1/roles&limit=' + pglimit.to_s)
+      res = @conn.get("/api/v1/roles&limit=#{pglimit}")
       rolecount = res['count'].to_i
       id = role_data_from_results(res, rolename)
       return id if id
 
       pages = (rolecount / pglimit) + 1
       2.upto(pages) do |i|
-        res = @conn.get('/api/v1/roles&limit=' + pglimit.to_s + '?page=' + i.to_s)
+        res = @conn.get("/api/v1/roles&limit=#{pglimit}?page=#{i}")
         id = role_data_from_results(res, rolename)
         return id if id
       end
@@ -74,7 +74,7 @@ module SFRest
     # @param [Integer] id the role id
     # @return [Hash] the role
     def role_data(id)
-      @conn.get('/api/v1/roles/' + id.to_s)
+      @conn.get("/api/v1/roles/#{id}")
     end
 
     # Creates a role.

data/lib/sfrest/site.rb

@@ -14,14 +14,14 @@ module SFRest
     # @return [Integer] the id of sitename
     def get_site_id(sitename)
       pglimit = 100
-      res = @conn.get('/api/v1/sites&limit=' + pglimit.to_s)
+      res = @conn.get("/api/v1/sites&limit=#{pglimit}")
       sitecount = res['count'].to_i
       id = site_data_from_results(res, sitename, 'id')
       return id if id
 
       pages = (sitecount / pglimit) + 1
       2.upto(pages) do |i|
-        res = @conn.get('/api/v1/sites&limit=' + pglimit.to_s + '?page=' + i.to_s)
+        res = @conn.get("/api/v1/sites&limit=#{pglimit}?page=#{i}")
         id = site_data_from_results(res, sitename, 'id')
         return id if id
       end
@@ -45,7 +45,7 @@ module SFRest
     # @param [Integer] site_id the site id
     # @return [Hash]
     def get_site_data(site_id)
-      @conn.get('/api/v1/sites/' + site_id.to_s)
+      @conn.get("/api/v1/sites/#{site_id}")
     end
 
     # gets the site id of the 1st one found using the api
@@ -60,6 +60,7 @@ module SFRest
     # @param [Boolean] show_incomplete whether to include incomplete sites in
     #   the list. The default differs from UI/SF to maintain backward compatibility.
     # @return [Hash{'count' => Integer, 'sites' => Hash}]
+    # rubocop: disable Style/OptionalBooleanParameter
     def site_list(show_incomplete = true)
       page = 1
       not_done = true
@@ -85,6 +86,7 @@ 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.
@@ -110,7 +112,7 @@ module SFRest
     # @param [Integer] site_id The id of the stie to be deleted
     # @return [Hash]
     def delete(site_id)
-      current_path = '/api/v1/sites/' + site_id.to_s
+      current_path = "/api/v1/sites/#{site_id}"
       @conn.delete current_path
     end
 

data/lib/sfrest/stage.rb

@@ -15,6 +15,7 @@ module SFRest
     # @param [Boolean] skip_gardener skip staging the gardener and only stage the sites
     #
     # @return [Integer] Id of the staging task created.
+    # rubocop: disable Style/OptionalBooleanParameter
     def stage(to_env = 'test', sites = nil, email_site_status = false, skip_gardener = false)
       raise InvalidApiVersion, staging_versions unless staging_versions.include? 1
 
@@ -23,6 +24,7 @@ module SFRest
                   'skip_gardener' => skip_gardener }.to_json
       @conn.post('/api/v1/stage', payload)
     end
+    # rubocop: enable Style/OptionalBooleanParameter
 
     # Stage a site using the new method
     # @param [String] to_env the name of of target env. defaults to test
@@ -30,21 +32,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,
+                       sites: [],
                        email_site_status: false,
                        wipe_target_environment: false,
-                       synchronize_all_users: true)
+                       synchronize_all_users: true,
+                       wipe_stacks: [])
       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
     #
@@ -60,12 +67,10 @@ module SFRest
       possible_versions = [1, 2]
       @versions ||= []
       possible_versions.each do |version|
-        begin
-          @conn.get "/api/v#{version}/stage"
-          @versions.push version
-        rescue SFRest::InvalidResponse
-          nil
-        end
+        @conn.get "/api/v#{version}/stage"
+        @versions.push version
+      rescue SFRest::InvalidResponse
+        nil
       end
       @versions
     end

data/lib/sfrest/task.rb

@@ -209,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}/logs"
       @conn.get(current_path)
     end
 
@@ -233,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}"
       payload = { 'paused' => true, 'level' => level }.to_json
       @conn.post(current_path, payload)
     end
@@ -243,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}"
       payload = { 'paused' => false, 'level' => level }.to_json
       @conn.post(current_path, payload)
     end
@@ -261,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}"
       @conn.delete(current_path)
     end
 
@@ -269,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/update.rb

@@ -26,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}"
       @conn.get(current_path)
     end
 
@@ -71,7 +71,7 @@ module SFRest
 
     # Gets the progress of an update by id.
     def update_progress(update_id)
-      current_path = '/api/v1/update/' + update_id.to_s + '/status'
+      current_path = "/api/v1/update/#{update_id}/status"
       @conn.get(current_path)
     end
 
@@ -109,7 +109,7 @@ module SFRest
       begin
         @conn.post '/api/v2/update', '{}'
       rescue SFRest::BadRequestError
-        return @has_v2_endpoint = true
+        @has_v2_endpoint = true
       rescue SFRest::InvalidResponse => e
         return @has_v2_endpoint = false if e.message =~ /Invalid data, status 404/
 

data/lib/sfrest/user.rb

@@ -16,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}"
         res = @conn.get(current_path)
         if res['users'] == []
           not_done = false
@@ -41,14 +41,14 @@ module SFRest
     # @return [Integer] the uid of the drupal user
     def get_user_id(username)
       pglimit = 100
-      res = @conn.get('/api/v1/users&limit=' + pglimit.to_s)
+      res = @conn.get("/api/v1/users&limit=#{pglimit}")
       usercount = res['count'].to_i
       id = user_data_from_results(res, username, 'uid')
       return id if id
 
       pages = (usercount / pglimit) + 1
       2.upto(pages) do |i|
-        res = @conn.get('/api/v1/users&limit=' + pglimit.to_s + '?page=' + i.to_s)
+        res = @conn.get("/api/v1/users&limit=#{pglimit}?page=#{i}")
         id = user_data_from_results(res, username, 'uid')
         return id if id
       end
@@ -72,7 +72,7 @@ module SFRest
     # @param [int] uid site id
     # @return [Hash]
     def get_user_data(uid)
-      @conn.get('/api/v1/users/' + uid.to_s)
+      @conn.get("/api/v1/users/#{uid}")
     end
 
     # Creates a user.

data/lib/sfrest/variable.rb

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

@@ -2,5 +2,5 @@
 
 module SFRest
   # Just tracks the version of sfrest.
-  VERSION = '0.0.28'
+  VERSION = '0.0.33'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sfrest
 version: !ruby/object:Gem::Version
-  version: 0.0.28
+  version: 0.0.33
 platform: ruby
 authors:
 - ACSF Engineering
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-08-27 00:00:00.000000000 Z
+date: 2021-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -70,32 +70,32 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.24'
+        version: '0'
 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.4
-signing_key: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: Acquia Site Factory Rest API.
 test_files: []