Class: Osm::Invoice

Inherits:
Model
  • Object
show all
Defined in:
lib/osm/invoice.rb

Defined Under Namespace

Classes: Item

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Model

#<, #<=, #>, #>=, #between?, #changed_attributes, configure, #reset_changed_attributes, #to_i

Constructor Details

#initializeObject

Initialize a new Budget


# File 'lib/osm/invoice.rb', line 39

Instance Attribute Details

#archivedBoolean


19
# File 'lib/osm/invoice.rb', line 19

attribute :id, :type => Integer

#dateDate


19
# File 'lib/osm/invoice.rb', line 19

attribute :id, :type => Integer

#extra_detailsString


19
# File 'lib/osm/invoice.rb', line 19

attribute :id, :type => Integer

#finalisedBoolean


19
# File 'lib/osm/invoice.rb', line 19

attribute :id, :type => Integer

#idFixnum


19
# File 'lib/osm/invoice.rb', line 19

attribute :id, :type => Integer

#nameString


19
# File 'lib/osm/invoice.rb', line 19

attribute :id, :type => Integer

#section_idFixnum


19
# File 'lib/osm/invoice.rb', line 19

attribute :id, :type => Integer

Class Method Details

.get(api, section, invoice_id, options = {}) ⇒ Osm::Invoice?

Get an invoice

Options Hash (options):

  • :no_cache (Boolean) — default: optional

    if true then the data will be retreived from OSM not the cache


89
90
91
92
93
94
95
96
97
98
99
100
101
# File 'lib/osm/invoice.rb', line 89

def self.get(api, section, invoice_id, options={})
  require_ability_to(api, :read, :events, section, options)
  section_id = section.to_i
  invoice_id = invoice_id.to_i
  cache_key = ['invoice', invoice_id]

  if !options[:no_cache] && cache_exist?(api, cache_key)
    return cache_read(api, cache_key)
  end

  invoice_data = api.perform_query("finances.php?action=getInvoice&sectionid=#{section_id}&invoiceid=#{invoice_id}")
  return self.new_invoice_from_data(invoice_data)
end

.get_for_section(api, section, options = {}) ⇒ Array<Osm::Invoice>

Get invoices for a section

Options Hash (options):

  • :no_cache (Boolean) — default: optional

    if true then the data will be retreived from OSM not the cache

  • :include_archived (Boolean) — default: optional

    if true then archived invoices will also be returned


50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/osm/invoice.rb', line 50

def self.get_for_section(api, section, options={})
  require_ability_to(api, :read, :finance, section, options)
  section_id = section.to_i
  cache_key = ['invoice_ids', section_id]
  invoices = nil

  if !options[:no_cache] && cache_exist?(api, cache_key)
    ids = cache_read(api, cache_key)
    invoices = get_from_ids(api, ids, 'invoice', section, options, :get_for_section)
  end

  if invoices.nil?
    data = api.perform_query("finances.php?action=getInvoices&sectionid=#{section_id}&showArchived=true")
    invoices = Array.new
    ids = Array.new
    unless data['items'].nil?
      data['items'].map { |i| i['invoiceid'].to_i }.each do |invoice_id|
        invoice_data = api.perform_query("finances.php?action=getInvoice&sectionid=#{section_id}&invoiceid=#{invoice_id}")
        invoice = self.new_invoice_from_data(invoice_data)
        invoices.push invoice
        ids.push invoice.id
        cache_write(api, ['invoice', invoice.id], invoice)
      end
    end
    cache_write(api, cache_key, ids)
  end

  return invoices if options[:include_archived]
  return invoices.reject do |invoice|
    invoice.archived?
  end
end

Instance Method Details

#<=>(another) ⇒ Object

Compare Invoice based on section_id, name then date


243
244
245
246
247
248
# File 'lib/osm/invoice.rb', line 243

def <=>(another)
  result = self.section_id <=> another.try(:section_id)
  result = self.name <=> another.try(:name) if result == 0
  result = self.date <=> another.try(:date) if result == 0
  return result
end

#archive(api) ⇒ Boolean

Archive the invoice in OSM, updating the archived attribute if successful. If the archived attribute is true then nothing happens and false is returned.

Raises:

  • (Osm::Error)

    If the invoice does not already exist in OSM


173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
# File 'lib/osm/invoice.rb', line 173

def archive(api)
  Osm::Model.require_ability_to(api, :write, :finance, section_id)
  raise Osm::Error, 'the invoice does not already exist in OSM' if id.nil?
  return false if archived?

  data = api.perform_query("finances.php?action=deleteInvoice&sectionid=#{section_id}", {
    'invoiceid' => id,
    'archived' => 1,
  })
  if (data.is_a?(Hash) && data['ok'].eql?(true))
    self.archived = true
    # The cached invoice for the section will be out of date - remove it
    cache_delete(api, ['invoice', self.id])
    return true
  end
  return false
end

#create(api) ⇒ Boolean

Create the invoice in OSM

Raises:


108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
# File 'lib/osm/invoice.rb', line 108

def create(api)
  raise Osm::Error, 'the invoice already exists in OSM' unless id.nil?
  raise Osm::ObjectIsInvalid, 'invoice is invalid' unless valid?
  Osm::Model.require_ability_to(api, :write, :finance, section_id)

  data = api.perform_query("finances.php?action=addInvoice&sectionid=#{section_id}", {
    'name' => name,
    'extra' => extra_details,
    'date' => date.strftime(Osm::OSM_DATE_FORMAT),
  })
  if data.is_a?(Hash) && !data['id'].nil?
    # The cached invoices for the section will be out of date - remove them
    cache_delete(api, ['invoice_ids', section_id])
    self.id = data['id'].to_i
    return true
  end
  return false
end

#delete(api) ⇒ Boolean

Delete the invoice from OSM


153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
# File 'lib/osm/invoice.rb', line 153

def delete(api)
  Osm::Model.require_ability_to(api, :write, :finance, section_id)
  return false if finalised?

  data = api.perform_query("finances.php?action=deleteInvoice&sectionid=#{section_id}", {
    'invoiceid' => id,
  })
  if (data.is_a?(Hash) && data['ok'].eql?(true))
    # The cached invoices for the section will be out of date - remove them
    cache_delete(api, ['invoice_ids', section_id])
    cache_delete(api, ['invoice', self.id])
    return true
  end
  return false
end

#finalise(api) ⇒ Boolean

Finalise the invoice in OSM, updating the finalised attribute if successful. If the finalised attribute is true then nothing happens and false is returned.

Raises:

  • (Osm::Error)

    If the invoice does not already exist in OSM


195
196
197
198
199
200
201
202
203
204
205
206
207
208
# File 'lib/osm/invoice.rb', line 195

def finalise(api)
  Osm::Model.require_ability_to(api, :write, :finance, section_id)
  raise Osm::Error, 'the invoice does not already exist in OSM' if id.nil?
  return false if finalised?

  data = api.perform_query("finances.php?action=finaliseInvoice&sectionid=#{section_id}&invoiceid=#{id}")
  if (data.is_a?(Hash) && data['ok'].eql?(true))
    self.finalised = true
    # The cached invoice for the section will be out of date - remove it
    cache_delete(api, ['invoice', self.id])
    return true
  end
  return false
end

#get_items(api, options = {}) ⇒ Array<Osm::Invoice::Item>

Get items for the invoice

Options Hash (options):

  • :no_cache (Boolean) — default: optional

    if true then the data will be retreived from OSM not the cache


214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
# File 'lib/osm/invoice.rb', line 214

def get_items(api, options={})
  require_ability_to(api, :read, :finance, section_id, options)
  cache_key = ['invoice_items', id]

  if !options[:no_cache] && cache_exist?(api, cache_key)
    return cache_read(api, cache_key)
  end

  items = Array.new
  data = api.perform_query("finances.php?action=getInvoiceRecords&invoiceid=#{id}&sectionid=#{section_id}&dateFormat=generic")
  data['items'].each do |item|
    items.push Osm::Invoice::Item.new(
      :id => Osm::to_i_or_nil(item['id']),
      :invoice => self,
      :record_id => Osm::to_i_or_nil(item['recordid']),
      :date => Osm::parse_date(item['entrydate']),
      :amount => item['amount'],
      :type => item['type'].to_s.downcase.to_sym,
      :payto => item['payto_userid'].to_s.strip,
      :description => item['comments'],
      :budget_name => item['categoryid'],
    )
  end

  cache_write(api, cache_key, items)
  return items
end

#update(api) ⇒ Boolan

Update the invoice in OSM

Raises:


131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'lib/osm/invoice.rb', line 131

def update(api)
  raise Osm::ObjectIsInvalid, 'invoice is invalid' unless valid?
  require_ability_to(api, :write, :finance, section_id)

  data = api.perform_query("finances.php?action=addInvoice&sectionid=#{section_id}", {
    'invoiceid' => id,
    'name' => name,
    'extra' => extra_details,
    'date' => date.strftime(Osm::OSM_DATE_FORMAT),
  })

  if data.is_a?(Hash) && data['ok'].eql?(true)
    reset_changed_attributes
    # The cached invoice will be out of date - remove it
    cache_delete(api, ['invoice', self.id])
    return true
  end
  return false
end