class Assembla::Client::Spaces::WikiPages

Constants

VALID_PARAMS_NAMES
VALID_REQUEST_PARAM_VALUES

Public Instance Methods

create(*args) click to toggle source

@example api.spaces.wiki_pages.create ‘project1’, wiki_page: { page_name: ‘Mobile App V2’ }

# File lib/assembla_api/client/spaces/wiki_pages.rb, line 23
def create(*args)
  arguments(args, required: [:space]) do
    permit VALID_PARAMS_NAMES, recursive: true
    assert_required %w[ page_name ]
    assert_values VALID_REQUEST_PARAM_VALUES
  end

  post_request("/spaces/#{arguments.space}/wiki_pages", arguments.params)
end
delete(*args) click to toggle source

Deletes wiki page by ID and all its children

@example api.spaces.wiki_pages.delete ‘project1’, ‘guid’

# File lib/assembla_api/client/spaces/wiki_pages.rb, line 55
def delete(*args)
  arguments(args, required: [:space, :id])
  delete_request("/spaces/#{arguments.space}/wiki_pages/#{arguments.id}/all", arguments.params)
end
delete_parent(*args) click to toggle source

Deletes wiki page by ID and moves all children with one level up

@example api.spaces.wiki_pages.delete_parent ‘project1’, ‘guid’

# File lib/assembla_api/client/spaces/wiki_pages.rb, line 64
def delete_parent(*args)
  arguments(args, required: [:space, :id])
  delete_request("/spaces/#{arguments.space}/wiki_pages/#{arguments.id}/container", arguments.params)
end
edit(*args) click to toggle source

@example api.spaces.wiki_pages.edit ‘project1’, ‘guid’, wiki_page: { position: 1 }

# File lib/assembla_api/client/spaces/wiki_pages.rb, line 42
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}/wiki_pages/#{arguments.id}", arguments.params)
end
get(*args) click to toggle source

@example api.spaces.wiki_pages.get ‘project1’, ‘guid’

# File lib/assembla_api/client/spaces/wiki_pages.rb, line 35
def get(*args)
  arguments(args, required: [:space, :id])
  get_request("/spaces/#{arguments.space}/wiki_pages/#{arguments.id}", arguments.params)
end
list(*args) { |el| ... } click to toggle source

@example api.spaces.wiki_pages.list ‘project1’

# File lib/assembla_api/client/spaces/wiki_pages.rb, line 71
def list(*args)
  arguments(args, required: [:space])
  response = get_request("/spaces/#{arguments.space}/wiki_pages", arguments.params)
  return response unless block_given?
  response.each { |el| yield el }
end