sfrest 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 94bd205352e9ec9465614828f2a5bb1b602217568ca5135b4c30223f0f16ec63
-  data.tar.gz: 9fdbde3ff4ba1b1811625b2eb48a3aa22c1f54e652747dc6ab6adf2fb3875348
+  metadata.gz: a349a8e1263871b5dde41d43c20abaa63b5fdf1894e0e08ca88f8d3ac4a05a10
+  data.tar.gz: 225785f5a1d526dedc9f1a5ae42c00c5633a618406907f4553399578c628b001
 SHA512:
-  metadata.gz: ce166dabdbc263441fc183a38f5b85700c0775a2b69249b2587c42950c441a6bf701814b786ebb1f307412dce7b9b357aaeda7b060c89bfea9259a0650bf2646
-  data.tar.gz: 7f98365d4da5f5121040b63fc6db432e3f67b2b368e365fef6f477c76de811fc5c8f6ba985fbe38e38acb660268b5b5833868c26d258534e050177078d57168e
+  metadata.gz: 350236e48e8d08f2bef2a7bdfd39c88c75390f5ef14e75a403fe096d610d9ed3ae74cb510b7719bdd2c42ba511a1aeb63b11c5d6df50c1150ee75923d3afb80b
+  data.tar.gz: a2f39e36afffd783303c9fd10f69374778e8f51f4df32b2d3afc7405beef2c4a2c1e89ae91b1442c08e6105935293e01d9557a40b0c284382bbe0b496f707f48

data/lib/sfrest/error.rb

@@ -25,4 +25,8 @@ module SFRest
 
   # If the return cannot be parsed into something useful
   class InvalidResponse < SFRest::SFError; end
+
+  # If you call an unsuported version
+  #
+  class InvalidApiVersion < SFRest::SFError; end
 end

data/lib/sfrest/site.rb

@@ -112,5 +112,13 @@ module SFRest
     def backup
       @conn.backup
     end
+
+    # Clears the caches for a site.
+    # @param [Integer] site_id The id of the site to be cleared
+    # @return [Hash]
+    def cache_clear(site_id)
+      current_path = "/api/v1/sites/#{site_id}/cache-clear"
+      @conn.post current_path, nil
+    end
   end
 end

data/lib/sfrest/stage.rb

@@ -14,18 +14,56 @@ module SFRest
     #
     # @return [Integer] Id of the staging task created.
     def stage(to_env = 'test', sites = nil, email_site_status = false, skip_gardener = false)
+      raise InvalidApiVersion, staging_versions unless staging_versions.include? 1
       payload = { 'to_env' => to_env, 'sites' => sites,
                   'detailed_status' => email_site_status,
                   'skip_gardener' => skip_gardener }.to_json
       @conn.post('/api/v1/stage', payload)
     end
 
+    # Stage a site using the new method
+    # @param [String] to_env the name of of target env. defaults to test
+    # @param [Array] sites Array of site nids to stage
+    # @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
+    #
+    # @return [Integer] Id of the staging task created.
+    def enhanced_stage(env: 'test',
+                       sites: nil,
+                       email_site_status: false,
+                       wipe_target_environment: false,
+                       synchronize_all_users: true)
+      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
+      @conn.post('/api/v2/stage', payload)
+    end
+
     # Query for available staging environments
     #
     # @return environments
     def list_staging_environments
-      current_path = '/api/v1/stage'
+      current_path = "/api/v#{staging_versions.sample}/stage"
       @conn.get(current_path)
     end
+
+    # determine what version are available for staging
+    # @return [Array] Array of available api endpoints
+    def staging_versions
+      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
+      end
+      @versions
+    end
   end
 end

data/lib/sfrest/task.rb

@@ -18,6 +18,15 @@ module SFRest
       @conn = conn
     end
 
+    # Returns true only if the status evaluates to not started
+    # or restarted
+    # @param [Integer] status
+    # @return [Boolean]
+    def status_not_started?(status)
+      return true if (status.to_i & STATUS_TO_BE_RUN) > 0
+      false
+    end
+
     # Returns true only if the status evaluates to completed
     # @param [Integer] status
     # @return [Boolean]
@@ -71,6 +80,15 @@ module SFRest
       res['wip_task']['status']
     end
 
+    # Returns true only if WIP reports the status as not started
+    # or restarted
+    # @param [Integer] task_id
+    # @return [Boolean]
+    def task_not_started?(task_id)
+      status = task_status task_id
+      status_not_started?(status)
+    end
+
     # Returns true only if WIP reports the status as running
     # @param [Integer] task_id
     # @return [Boolean]
@@ -220,6 +238,23 @@ module SFRest
       @conn.post(current_path, payload)
     end
 
+    # Terminates a specific task identified by its task id.
+    # This will terminate the task and its children
+    # @param [Integer] task_id
+    def terminate_task(task_id)
+      current_path = "/api/v1/tasks/#{task_id}/terminate"
+      payload = nil
+      @conn.put(current_path, payload)
+    end
+
+    # Deletes a specific task identified by its task id.
+    # 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
+      @conn.delete(current_path)
+    end
+
     # returns the classes that are either softpaused or softpause-for-update
     # @param [String] type softpaused | softpause-for-update
     # @return [Array] Array of wip classes

data/lib/sfrest/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sfrest
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
 platform: ruby
 authors:
 - ACSF Engineering
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-26 00:00:00.000000000 Z
+date: 2018-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon
@@ -141,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Acquia Site Factory Rest API.