Class: Assembla::Client::Spaces::Tickets::CustomFields

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

Constant Summary collapse

VALID_PARAMS_NAMES = 
%w{type title order required hide default_value list_options}
VALID_REQUEST_PARAM_VALUES = 
{
  'type' => %w{text numeric team\ list list date},
  'required' => [true, false],
  'hide' => [true, false]
}

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.tickets.custom_fields.create ‘project1’, custom_field: { title: ‘Build’ }



12
13
14
15
16
17
18
19
20
 
# File 'lib/assembla_api/client/spaces/tickets/custom_fields.rb', line 12

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

  post_request("/spaces/#{arguments.space}/tickets/custom_fields", arguments.params)
end

#delete(*args) ⇒ Object

Delete ticket status by ID api.spaces.tickets.custom_fields.delete ‘project1’, 34



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

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

#edit(*args) ⇒ Object

api.spaces.tickets.custom_fields.edit ‘project1’, 34, custom_field: ‘Build Number’, type: ‘numeric’



31
32
33
34
35
36
37
38
 
# File 'lib/assembla_api/client/spaces/tickets/custom_fields.rb', line 31

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

#get(*args) ⇒ Object

api.spaces.tickets.custom_fields.get ‘project1’, 34



24
25
26
27
 
# File 'lib/assembla_api/client/spaces/tickets/custom_fields.rb', line 24

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

#list(*args) ⇒ Object

api.spaces.tickets.custom_fields.list ‘project1’



50
51
52
53
54
55
 
# File 'lib/assembla_api/client/spaces/tickets/custom_fields.rb', line 50

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