Class: Assembla::Client::Spaces::Ssh::Actions

Inherits:
API
  • Object
show all
Defined in:
lib/assembla_api/client/spaces/ssh/actions.rb

Defined Under Namespace

Classes: Launches

Constant Summary collapse

VALID_PARAMS_NAMES = 
%w[
  name
  command
  description
  frequency
  username
  position
  ssh_tool_server_id
].freeze
VALID_REQUEST_PARAM_VALUES = 
{
  'frequency' => [ 0, 1, 2, 10, 11, 12 ],
  'name' => /^[a-zA-Z0-9 _]+$/
}

Constants included from MimeType

MimeType::MEDIA_LOOKUP

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

#current_options

Attributes included from Authorization

#scopes

Instance Method Summary collapse

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

#lookup_media, #parse

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.actions.create ‘project1’, ssh_action: { name: ‘Stage’ }



24
25
26
27
28
29
30
31
32
 
# File 'lib/assembla_api/client/spaces/ssh/actions.rb', line 24

def create(*args)
  arguments(args, required: [:space]) do
    permit VALID_PARAMS_NAMES, recursive: true
    assert_required %w[ name command username ]
    assert_values VALID_REQUEST_PARAM_VALUES
  end

  post_request("/spaces/#{arguments.space}/ssh/actions", arguments.params)
end

#delete(*args) ⇒ Object

Delete ssh action by ID api.spaces.ssh.actions.delete ‘project1’, 7



62
63
64
65
 
# File 'lib/assembla_api/client/spaces/ssh/actions.rb', line 62

def delete(*args)
  arguments(args, required: [:space, :id])
  delete_request("/spaces/#{arguments.space}/ssh/actions/#{arguments.id}", arguments.params)
end

#edit(*args) ⇒ Object

api.spaces.ssh.actions.edit ‘project1’, 7, ssh_action: { description: ‘Do not deploy!’ }



50
51
52
53
54
55
56
57
 
# File 'lib/assembla_api/client/spaces/ssh/actions.rb', line 50

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/actions/#{arguments.id}", arguments.params)
end

#get(*args) ⇒ Object

api.spaces.ssh.actions.get ‘project1’, 7



36
37
38
39
 
# File 'lib/assembla_api/client/spaces/ssh/actions.rb', line 36

def get(*args)
  arguments(args, required: [:space, :id])
  get_request("/spaces/#{arguments.space}/ssh/actions/#{arguments.id}", arguments.params)
end

#list(*args) ⇒ Object

api.spaces.ssh.actions.list ‘project1’



69
70
71
72
73
74
 
# File 'lib/assembla_api/client/spaces/ssh/actions.rb', line 69

def list(*args)
  arguments(args, required: [:space])
  response = get_request("/spaces/#{arguments.space}/ssh/actions", arguments.params)
  return response unless block_given?
  response.each { |el| yield el }
end

#run(*args) ⇒ Object

api.spaces.ssh.actions.run ‘project1’, 7



43
44
45
46
 
# File 'lib/assembla_api/client/spaces/ssh/actions.rb', line 43

def run(*args)
  arguments(args, required: [:space, :id])
  get_request("/spaces/#{arguments.space}/ssh/actions/#{arguments.id}/run", arguments.params)
end