Class: LabClient::ProtectedEnvironments

Inherits:
Common
  • Object
show all
Defined in:
lib/labclient/protected_environments/list.rb,
lib/labclient/protected_environments/show.rb,
lib/labclient/protected_environments/protect.rb,
lib/labclient/protected_environments/unprotect.rb

Overview

Specifics

Constant Summary

Constants included from AccessLevel

AccessLevel::HUMAN_ACCESS_LEVELS, AccessLevel::MACHINE_ACCESS_LEVELS

Instance Attribute Summary

Attributes inherited from Common

#client

Instance Method Summary collapse

Methods inherited from Common

#api_methods, #api_methods_help, #format_id, #format_query_id, #format_query_ids, #format_time?, #group_name, #help, #initialize, #inspect, #klass, #protected_query_access_level, #query_access_level, #query_format_time

Methods included from Docs

#demo, #desc, #doc, docs, #example, #group_name, #help, json, #markdown, #navigation, #option, #result, #subtitle, #title

Methods included from AccessLevel

#human_access_level, #human_protected_access_level, #machine_access_level, #machine_protected_access_level

Constructor Details

This class inherits a constructor from LabClient::Common

Instance Method Details

#list(project_id) ⇒ Object 



23
24
25
26
27
 
# File 'lib/labclient/protected_environments/list.rb', line 23

def list(project_id)
  project_id = format_id(project_id)

  client.request(:get, "projects/#{project_id}/protected_environments", ProtectedEnvironment)
end

#protect(project_id, query) ⇒ Object 



44
45
46
47
48
49
50
51
 
# File 'lib/labclient/protected_environments/protect.rb', line 44

def protect(project_id, query)
  query[:deploy_access_levels].each do |access_level|
    protected_query_access_level(access_level, :access_level)
  end

  project_id = format_id(project_id)
  client.request(:post, "projects/#{project_id}/protected_environments", ProtectedEnvironment, query)
end

#show(project_id, environment_id) ⇒ Object 



19
20
21
22
 
# File 'lib/labclient/protected_environments/show.rb', line 19

def show(project_id, environment_id)
  project_id = format_id(project_id)
  client.request(:get, "projects/#{project_id}/protected_environments/#{environment_id}", ProtectedEnvironment)
end

#unprotect(project_id, environment_id) ⇒ Object 



26
27
28
29
 
# File 'lib/labclient/protected_environments/unprotect.rb', line 26

def unprotect(project_id, environment_id)
  project_id = format_id(project_id)
  client.request(:delete, "projects/#{project_id}/protected_environments/#{environment_id}")
end