Class: Box::File

Inherits:

Item

• Object
• Item
• Box::File

show all

Defined in:

lib/box/file.rb

Overview

Instance Attribute Summary

Attributes inherited from Item

api, data, parent

Class Method Summary (collapse)

• + (String) type

  The string representation of this item.

Instance Method Summary (collapse)

• - (Comment) add_comment(message)

  Add a comment to the file.

• - (Object) download(path)

  Download this file to the specified path.

• - (String) embed_code(options = Hash.new)

  Request the HTML embed code for this file.

• - (Array) get_comments

  Get the comments left on this file.

• - (File) upload_copy(path)

  Upload a new copy of this file.

• - (File) upload_overwrite(path)

  Overwrite this file, using the file at the specified path.

Methods inherited from Item

#copy, #delete, #force_cached_info, #id, #info, #initialize, #method_missing, #move, #path, #rename, #respond_to?, #set_description, #share_private, #share_public, #type, #types, types, #unshare

9

# File 'lib/box/file.rb', line 9

def self.type; 'file'; end

57
58
59
60
61

# File 'lib/box/file.rb', line 57

def add_comment(message)
  response = @api.add_comment(type, id, message)

  Comment.create(@api, response['comment']).first
end

14
15
16

# File 'lib/box/file.rb', line 14

def download(path)
  @api.download(path, id)
end

71
72
73
74
75
76
77
78

# File 'lib/box/file.rb', line 71

def embed_code(options = Hash.new)
  begin
    @api.file_embed(id, options)['file_embed_html']
  rescue Api::NotShared
    share_public
    retry
  end
end

46
47
48
49
50
51
52

# File 'lib/box/file.rb', line 46

def get_comments
  comments = @api.get_comments(type, id)['comments']

  comments = Comment.create(@api, comments['comment']) if comments

  @data['comments'] = comments || Array.new
end

36
37
38
39
40
41

# File 'lib/box/file.rb', line 36

def upload_copy(path)
  info = @api.new_copy(path, id)['files']['file']
  parent.delete_info('files')

  self.class.new(api, parent, info)
end

22
23
24
25
26
27
28
29

# File 'lib/box/file.rb', line 22

def upload_overwrite(path)
  info = @api.overwrite(path, id)['files']['file']

  clear_info
  update_info(info)

  self
end