Class: Assembla::Client::Tasks

Inherits:
API
  • Object
show all
Defined in:
lib/assembla_api/client/tasks.rb

Constant Summary collapse

VALID_PARAMS_NAMES = 
%w{
  description
  job_agreement_id
  space_id
  ticket_id
  url
  hours
  begin_at
  end_at
}

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 



22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/assembla_api/client/tasks.rb', line 22

def create(*args)
  arguments(args) do
    permit VALID_PARAMS_NAMES, recursive: true
    assert_required %w[ description space_id ]
  end

  task = arguments.params['user_task'] = arguments.params.delete 'task'
  task['begin_at'] ||= Time.now.utc.strftime '%FT%TZ'
  task['hours'] ||= 1

  post_request("/tasks", arguments.params)
end

#delete(*args) ⇒ Object Also known as: remove 



35
36
37
38
 
# File 'lib/assembla_api/client/tasks.rb', line 35

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

#edit(*args) ⇒ Object

Edit a task

Examples:

api = Assembla.new
api.tasks.edit 963, task: {
  url: 'http://google.com',
  description: 'Search using new engine'
}

Parameters:



53
54
55
56
57
58
59
60
61
 
# File 'lib/assembla_api/client/tasks.rb', line 53

def edit(*args)
  arguments(args, required: [:id]) do
    permit VALID_PARAMS_NAMES, recursive: true
  end

  arguments.params['user_task'] = arguments.params.delete 'task'

  put_request("/tasks/#{arguments.id}", arguments.params)
end

#get(*args) ⇒ Object Also known as: find

api.tasks.get 963



16
17
18
19
 
# File 'lib/assembla_api/client/tasks.rb', line 16

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

#list(*args) ⇒ Object

api.tasks.list



65
66
67
68
69
70
 
# File 'lib/assembla_api/client/tasks.rb', line 65

def list(*args)
  arguments(args)
  response = get_request("/tasks", arguments.params)
  return response unless block_given?
  response.each { |el| yield el }
end