Class: Assembla::Client::Spaces::Documents

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

Constant Summary collapse

VALID_PARAMS_NAMES = 
%w[
  file
  filename
  name
  description
  position
  cached_tag_list
  attachable_type
  attachable_guid
  attachable_id
].freeze
VALID_REQUEST_PARAM_VALUES = 
{
  'attachable_type' => /^(Ticket|Flow|Milestone)$/
}

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.documents.create ‘project1’, document: { file: ‘/path/to/file’ }



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/assembla_api/client/spaces/documents.rb', line 24

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

  doc = arguments.params.delete 'document'
  path = doc['file']
  name = File.basename(path)
  mime = MIME::Types.of(name).first
  file = Faraday::UploadIO.new(path, mime ? mime.content_type : 'application/octet-stream')
  doc['name'] ||= name
  doc['file'] = file
  arguments.params['data'] = { 'document' => doc }
  arguments.params['options'] = { headers: { content_type: 'multipart/form-data' }}

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

#delete(*args) ⇒ Object

Delete document by ID api.spaces.documents.delete ‘project1’, ‘guid’



73
74
75
76
 
# File 'lib/assembla_api/client/spaces/documents.rb', line 73

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

#download(*args) ⇒ Object

api.spaces.documents.download ‘project1’, ‘guid’



53
54
55
56
57
 
# File 'lib/assembla_api/client/spaces/documents.rb', line 53

def download(*args)
  arguments(args, required: [:space, :id])
  arguments.params['raw'] = true
  get_request("/spaces/#{arguments.space}/documents/#{arguments.id}/download", arguments.params)
end

#edit(*args) ⇒ Object

api.spaces.documents.edit ‘project1’, ‘guid’, document: { description: “Confidential” }



61
62
63
64
65
66
67
68
 
# File 'lib/assembla_api/client/spaces/documents.rb', line 61

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

#get(*args) ⇒ Object

api.spaces.documents.get ‘project1’, ‘guid’



46
47
48
49
 
# File 'lib/assembla_api/client/spaces/documents.rb', line 46

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

#list(*args) ⇒ Object

api.spaces.documents.list ‘project1’



80
81
82
83
84
85
 
# File 'lib/assembla_api/client/spaces/documents.rb', line 80

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