Class: Assembla::Client::Spaces::Milestones

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

Constant Summary collapse

VALID_PARAMS_NAMES = 
%w[
  title
  user_id
  is_completed
  release_level
  release_notes
  planner_type
].freeze
VALID_REQUEST_PARAM_VALUES = 
{
  'release_level' => [ 1, 2, 3 ],   # Alpha, Beta, Stable
  'planner_type' => [ 0, 1, 2 ],    # None, Backlog, Current
  'is_completed' => [ 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

#all(*args) ⇒ Object

api.spaces.milestones.all ‘project1’



68
69
70
71
72
73
 
# File 'lib/assembla_api/client/spaces/milestones.rb', line 68

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

#completed(*args) ⇒ Object

api.spaces.milestones.completed ‘project1’



77
78
79
80
81
82
 
# File 'lib/assembla_api/client/spaces/milestones.rb', line 77

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

#create(*args) ⇒ Object

api.spaces.milestones.create ‘project1’, milestone: { title: ‘Mobile App V2’ }



21
22
23
24
25
26
27
28
29
 
# File 'lib/assembla_api/client/spaces/milestones.rb', line 21

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}/milestones", arguments.params)
end

#delete(*args) ⇒ Object

Delete milestone by ID api.spaces.milestones.delete ‘project1’, 7



52
53
54
55
 
# File 'lib/assembla_api/client/spaces/milestones.rb', line 52

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

#edit(*args) ⇒ Object

api.spaces.milestones.edit ‘project1’, 7, milestone: { is_completed: true }



40
41
42
43
44
45
46
47
 
# File 'lib/assembla_api/client/spaces/milestones.rb', line 40

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

#get(*args) ⇒ Object

api.spaces.milestones.get ‘project1’, 7



33
34
35
36
 
# File 'lib/assembla_api/client/spaces/milestones.rb', line 33

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

#list(*args) ⇒ Object

api.spaces.milestones.list ‘project1’



59
60
61
62
63
64
 
# File 'lib/assembla_api/client/spaces/milestones.rb', line 59

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

#release_notes(*args) ⇒ Object

api.spaces.milestones.release_notes ‘project1’



95
96
97
98
99
100
 
# File 'lib/assembla_api/client/spaces/milestones.rb', line 95

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

#upcoming(*args) ⇒ Object

api.spaces.milestones.upcoming ‘project1’



86
87
88
89
90
91
 
# File 'lib/assembla_api/client/spaces/milestones.rb', line 86

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