Class: Assembla::Client::Spaces::Ssh::Servers
- Defined in:
- lib/assembla_api/client/spaces/ssh/servers.rb
Constant Summary collapse
- VALID_PARAMS_NAMES =
%w[ name remote_port remote_host description ].freeze
- VALID_REQUEST_PARAM_VALUES =
{ 'name' => /^[a-zA-Z0-9 _]+$/ }
Constants included from MimeType
Constants included from Assembla::Constants
Assembla::Constants::ACCEPT, Assembla::Constants::ACCEPTED_OAUTH_SCOPES, Assembla::Constants::ACCEPT_CHARSET, Assembla::Constants::CACHE_CONTROL, Assembla::Constants::CONTENT_LENGTH, Assembla::Constants::CONTENT_TYPE, Assembla::Constants::DATE, Assembla::Constants::ETAG, Assembla::Constants::HEADER_LAST, Assembla::Constants::HEADER_LINK, Assembla::Constants::HEADER_NEXT, Assembla::Constants::LOCATION, Assembla::Constants::META_FIRST, Assembla::Constants::META_LAST, Assembla::Constants::META_NEXT, Assembla::Constants::META_PREV, Assembla::Constants::META_REL, Assembla::Constants::OAUTH_SCOPES, Assembla::Constants::PARAM_PAGE, Assembla::Constants::PARAM_PER_PAGE, Assembla::Constants::PARAM_START_PAGE, Assembla::Constants::RATELIMIT_LIMIT, Assembla::Constants::RATELIMIT_REMAINING, Assembla::Constants::SERVER, Assembla::Constants::USER_AGENT
Instance Attribute Summary
Attributes inherited from API
Attributes included from Authorization
Instance Method Summary collapse
-
#create(*args) ⇒ Object
api.spaces.ssh.servers.create ‘project1’, ssh_server: { name: ‘Stage’ }.
-
#delete(*args) ⇒ Object
Delete ssh server by ID api.spaces.ssh.servers.delete ‘project1’, 7.
-
#edit(*args) ⇒ Object
api.spaces.ssh.servers.edit ‘project1’, 7, ssh_server: { description: ‘Do not deploy!’ }.
-
#get(*args) ⇒ Object
api.spaces.ssh.servers.get ‘project1’, 7.
-
#list(*args) ⇒ Object
api.spaces.ssh.servers.list ‘project1’.
Methods inherited from API
after_callbacks, after_request, #api_methods_in, #arguments, before_callbacks, before_request, clear_request_methods!, #execute, extend_with_actions, extra_methods, extract_class_name, #filter_callbacks, inherited, #initialize, internal_methods, method_added, #method_missing, #module_methods_in, namespace, #process_basic_auth, request_methods, root!, #run_callbacks, #set, #setup, #with, #yield_or_eval
Methods included from Assembla::ClassMethods
#configuration, #configure, #require_all
Methods included from RateLimit
#ratelimit, #ratelimit_remaining, #ratelimit_reset
Methods included from Request::Verbs
#delete_request, #get_request, #head_request, #options_request, #patch_request, #post_request, #put_request
Methods included from MimeType
Methods included from Authorization
#auth_code, #authenticated?, #authentication, #authorize_url, #basic_authed?, #client, #get_token
Constructor Details
This class inherits a constructor from Assembla::API
Dynamic Method Handling
This class handles dynamic methods through the method_missing method in the class Assembla::API
Instance Method Details
#create(*args) ⇒ Object
api.spaces.ssh.servers.create ‘project1’, ssh_server: { name: ‘Stage’ }
16 17 18 19 20 21 22 23 24 25 26 |
# File 'lib/assembla_api/client/spaces/ssh/servers.rb', line 16 def create(*args) arguments(args, required: [:space]) do permit VALID_PARAMS_NAMES, recursive: true assert_required %w[ remote_host name ] assert_values VALID_REQUEST_PARAM_VALUES end arguments.params['ssh_server']['remote_port'] ||= 22 post_request("/spaces/#{arguments.space}/ssh/servers", arguments.params) end |
#delete(*args) ⇒ Object
Delete ssh server by ID api.spaces.ssh.servers.delete ‘project1’, 7
49 50 51 52 |
# File 'lib/assembla_api/client/spaces/ssh/servers.rb', line 49 def delete(*args) arguments(args, required: [:space, :id]) delete_request("/spaces/#{arguments.space}/ssh/servers/#{arguments.id}", arguments.params) end |
#edit(*args) ⇒ Object
api.spaces.ssh.servers.edit ‘project1’, 7, ssh_server: { description: ‘Do not deploy!’ }
37 38 39 40 41 42 43 44 |
# File 'lib/assembla_api/client/spaces/ssh/servers.rb', line 37 def edit(*args) arguments(args, required: [:space, :id]) do permit VALID_PARAMS_NAMES , recursive: true assert_values VALID_REQUEST_PARAM_VALUES end put_request("/spaces/#{arguments.space}/ssh/servers/#{arguments.id}", arguments.params) end |
#get(*args) ⇒ Object
api.spaces.ssh.servers.get ‘project1’, 7
30 31 32 33 |
# File 'lib/assembla_api/client/spaces/ssh/servers.rb', line 30 def get(*args) arguments(args, required: [:space, :id]) get_request("/spaces/#{arguments.space}/ssh/servers/#{arguments.id}", arguments.params) end |
#list(*args) ⇒ Object
api.spaces.ssh.servers.list ‘project1’
56 57 58 59 60 61 |
# File 'lib/assembla_api/client/spaces/ssh/servers.rb', line 56 def list(*args) arguments(args, required: [:space]) response = get_request("/spaces/#{arguments.space}/ssh/servers", arguments.params) return response unless block_given? response.each { |el| yield el } end |