Class: Gdoc::Document

Inherits:

Object

• Object
• Gdoc::Document

show all

Defined in:

lib/gdoc/document.rb

Instance Attribute Summary (collapse)

• - (Object) author

  Returns the value of attribute author.

• - (Object) doc_id

  Returns the value of attribute doc_id.

• - (Object) href

  Returns the value of attribute href.

• - (Object) last_modified_by

  Returns the value of attribute last_modified_by.

• - (Object) last_updated

  Returns the value of attribute last_updated.

• - (Object) last_viewed

  Returns the value of attribute last_viewed.

• - (Object) links

  Returns the value of attribute links.

• - (Object) parent

  Returns the value of attribute parent.

• - (Object) permissions readonly

  Returns the value of attribute permissions.

• - (Object) title

  Returns the value of attribute title.

• - (Object) type

  Returns the value of attribute type.

• - (Object) writers_can_invite

  Returns the value of attribute writers_can_invite.

• - (Object) xml readonly

  Returns the value of attribute xml.

Instance Method Summary (collapse)

• - (Object) <=>(document)
• - (Object) add_permission(email, role)
• - (Object) full_title

  Full title, including parent folder path.

• - (Document) initialize(title, options = {}) constructor

  Initializer.

• - (Object) inspect
• - (Object) to_s
• - (Object) to_xml

45
46
47
48
49
50
51
52
53
54

# File 'lib/gdoc/document.rb', line 45

def initialize(title, options={})
  @title = title
  @links = {}
  @type = options[:type] || ''
  @last_updated = options[:last_updated] || DateTime.new
  @last_viewed = options[:last_viewed] || DateTime.new
  @xml = options[:xml] || nil
  @permissions = {'owner' => [], 'reader' => [], 'writer' => []}
  @parent = options[:parent] || nil
end

30
31
32

# File 'lib/gdoc/document.rb', line 30

def author
  @author
end

30
31
32

# File 'lib/gdoc/document.rb', line 30

def doc_id
  @doc_id
end

30
31
32

# File 'lib/gdoc/document.rb', line 30

def href
  @href
end

30
31
32

# File 'lib/gdoc/document.rb', line 30

def last_modified_by
  @last_modified_by
end

30
31
32

# File 'lib/gdoc/document.rb', line 30

def last_updated
  @last_updated
end

30
31
32

# File 'lib/gdoc/document.rb', line 30

def last_viewed
  @last_viewed
end

30
31
32

# File 'lib/gdoc/document.rb', line 30

def links
  @links
end

30
31
32

# File 'lib/gdoc/document.rb', line 30

def parent
  @parent
end

29
30
31

# File 'lib/gdoc/document.rb', line 29

def permissions
  @permissions
end

30
31
32

# File 'lib/gdoc/document.rb', line 30

def title
  @title
end

30
31
32

# File 'lib/gdoc/document.rb', line 30

def type
  @type
end

30
31
32

# File 'lib/gdoc/document.rb', line 30

def writers_can_invite
  @writers_can_invite
end

29
30
31

# File 'lib/gdoc/document.rb', line 29

def xml
  @xml
end

77
78
79

# File 'lib/gdoc/document.rb', line 77

def <=>(document)
  @title.casecmp(document.title) # need case-insensitive version of <=>
end

56
57
58
59
60
61
62
63
64
65
66

# File 'lib/gdoc/document.rb', line 56

def add_permission(email, role)
  role.downcase!
  return if !@permissions.has_key?(role)

  if email.class == String
    @permissions[role].push(email)
  elsif email.class == Array
    @permissions[role] = @permissions[role] | email
  end
  @permissions[role].uniq!
end

69
70
71
72
73
74
75

# File 'lib/gdoc/document.rb', line 69

def full_title
  t = ""
  if parent
    t = parent.full_title + "/"
  end
  return t + title
end

91
92
93

# File 'lib/gdoc/document.rb', line 91

def inspect
  self.to_s
end

81
82
83
84
85

# File 'lib/gdoc/document.rb', line 81

def to_s
  [@title, ", doc_id: #{@doc_id} (#{@type})",
  "\nlinks: #{@links.inspect}",
  "\npermissions:\n#{@permissions.inspect}"].join
end

87
88
89

# File 'lib/gdoc/document.rb', line 87

def to_xml
  @xml
end