Module: CouchRest::Mixins::ExtendedAttachments

Included in:
ExtendedDocument
Defined in:
lib/couchrest/mixins/extended_attachments.rb

Instance Method Summary (collapse)

Instance Method Details

- (Object) attachment_uri(attachment_name)

returns URI to fetch the attachment from



49
50
51
52
# File 'lib/couchrest/mixins/extended_attachments.rb', line 49

def attachment_uri(attachment_name)
  return unless has_attachment?(attachment_name)
  "#{database.uri}/#{self.id}/#{attachment_name}"
end

- (Object) attachment_url(attachment_name)

returns URL to fetch the attachment from



43
44
45
46
# File 'lib/couchrest/mixins/extended_attachments.rb', line 43

def attachment_url(attachment_name)
  return unless has_attachment?(attachment_name)
  "#{database.root}/#{self.id}/#{attachment_name}"
end

- (Object) create_attachment(args = {})

Add a file attachment to the current document. Expects :file and :name to be included in the arguments.



7
8
9
10
11
12
13
14
# File 'lib/couchrest/mixins/extended_attachments.rb', line 7

def create_attachment(args={})
  raise ArgumentError unless args[:file] && args[:name]
  return if has_attachment?(args[:name])
  self['_attachments'] ||= {}
  set_attachment_attr(args)
rescue ArgumentError => e
  raise ArgumentError, 'You must specify :file and :name'
end

- (Object) delete_attachment(attachment_name)

deletes a file attachment from the current doc



32
33
34
35
# File 'lib/couchrest/mixins/extended_attachments.rb', line 32

def delete_attachment(attachment_name)
  return unless self['_attachments']
  self['_attachments'].delete attachment_name
end

- (Boolean) has_attachment?(attachment_name)

returns true if attachment_name exists



38
39
40
# File 'lib/couchrest/mixins/extended_attachments.rb', line 38

def has_attachment?(attachment_name)
  !!(self['_attachments'] && self['_attachments'][attachment_name] && !self['_attachments'][attachment_name].empty?)
end

- (Object) read_attachment(attachment_name)

reads the data from an attachment



17
18
19
# File 'lib/couchrest/mixins/extended_attachments.rb', line 17

def read_attachment(attachment_name)
  database.fetch_attachment(self, attachment_name)
end

- (Object) update_attachment(args = {})

modifies a file attachment on the current doc



22
23
24
25
26
27
28
29
# File 'lib/couchrest/mixins/extended_attachments.rb', line 22

def update_attachment(args={})
  raise ArgumentError unless args[:file] && args[:name]
  return unless has_attachment?(args[:name])
  delete_attachment(args[:name])
  set_attachment_attr(args)
rescue ArgumentError => e
  raise ArgumentError, 'You must specify :file and :name'
end