Class: Osm::Event
Defined Under Namespace
Classes: Attendance, Column
Instance Attribute Summary collapse
-
#allow_booking ⇒ Boolean
Whether booking is allowed through My.SCOUT.
-
#allow_changes ⇒ Boolean
Whether parent’s can change their child’s details.
-
#archived ⇒ Boolean
If the event has been archived.
-
#attendance_limit ⇒ Fixnum
The maximum number of people who can attend the event (0 = no limit).
-
#columns ⇒ Array<Osm::Event::Column>
The custom columns for the event.
-
#confirm_by_date ⇒ Date
The date parents can no longer add/change their child’s details.
-
#cost ⇒ String
The cost of the event (formatted to d+.d2) or “TBC”.
-
#finish ⇒ DateTime
When the event ends.
-
#id ⇒ Fixnum
The id for the event.
-
#location ⇒ String
Where the event is.
-
#name ⇒ String
The name of the event.
-
#notepad ⇒ String
Notepad for the event.
-
#notes ⇒ String
Notes about the event.
-
#public_notepad ⇒ String
Public notepad (shown in My.SCOUT) for the event.
-
#reminders ⇒ Boolean
Whether email reminders are sent for the event.
-
#section_id ⇒ Fixnum
The id for the section.
-
#start ⇒ DateTime
When the event starts.
Class Method Summary collapse
-
.create(api, parameters) ⇒ Osm::Event?
Create an event in OSM.
-
.get(api, section, event_id, options = {}) ⇒ Osm::Event?
Get an event.
-
.get_for_section(api, section, options = {}) ⇒ Array<Osm::Event>
Get events for a section.
Instance Method Summary collapse
-
#<=>(another) ⇒ Object
Compare Event based on start, name then id.
-
#add_column(api, name, label = '') ⇒ Boolean
Add a column to the event in OSM.
-
#cost_free? ⇒ Boolean
Whether the cost is zero.
-
#cost_tbc? ⇒ Boolean
Whether the cost is to be confirmed.
-
#delete(api) ⇒ Boolean
Delete event from OSM.
-
#get_attendance(api, term = nil, options = {}) ⇒ Array<Osm::Event::Attendance>
Get event attendance.
-
#initialize ⇒ Object
constructor
Initialize a new Event.
-
#limited_attendance? ⇒ Boolean
Whether thete is a limit on attendance for this event.
-
#spaces(api) ⇒ Fixnum?
Get the number of spaces left for the event.
-
#spaces?(api) ⇒ Boolean
Whether there are spaces left for the event.
-
#update(api) ⇒ Boolean
Update event in OSM.
Methods inherited from Model
#<, #<=, #>, #>=, #between?, #changed_attributes, configure, #reset_changed_attributes, #to_i
Constructor Details
#initialize ⇒ Object
Initialize a new Event
|
# File 'lib/osm/event.rb', line 78
|
Instance Attribute Details
#allow_booking ⇒ Boolean
Returns whether booking is allowed through My.SCOUT.
43 |
# File 'lib/osm/event.rb', line 43 attribute :id, :type => Integer |
#allow_changes ⇒ Boolean
Returns whether parent’s can change their child’s details.
43 |
# File 'lib/osm/event.rb', line 43 attribute :id, :type => Integer |
#archived ⇒ Boolean
Returns if the event has been archived.
43 |
# File 'lib/osm/event.rb', line 43 attribute :id, :type => Integer |
#attendance_limit ⇒ Fixnum
Returns the maximum number of people who can attend the event (0 = no limit).
43 |
# File 'lib/osm/event.rb', line 43 attribute :id, :type => Integer |
#columns ⇒ Array<Osm::Event::Column>
Returns the custom columns for the event.
43 |
# File 'lib/osm/event.rb', line 43 attribute :id, :type => Integer |
#confirm_by_date ⇒ Date
Returns the date parents can no longer add/change their child’s details.
43 |
# File 'lib/osm/event.rb', line 43 attribute :id, :type => Integer |
#cost ⇒ String
Returns the cost of the event (formatted to d+.d2) or “TBC”.
43 |
# File 'lib/osm/event.rb', line 43 attribute :id, :type => Integer |
#finish ⇒ DateTime
Returns when the event ends.
43 |
# File 'lib/osm/event.rb', line 43 attribute :id, :type => Integer |
#id ⇒ Fixnum
Returns the id for the event.
43 |
# File 'lib/osm/event.rb', line 43 attribute :id, :type => Integer |
#location ⇒ String
Returns where the event is.
43 |
# File 'lib/osm/event.rb', line 43 attribute :id, :type => Integer |
#name ⇒ String
Returns the name of the event.
43 |
# File 'lib/osm/event.rb', line 43 attribute :id, :type => Integer |
#notepad ⇒ String
Returns notepad for the event.
43 |
# File 'lib/osm/event.rb', line 43 attribute :id, :type => Integer |
#notes ⇒ String
Returns notes about the event.
43 |
# File 'lib/osm/event.rb', line 43 attribute :id, :type => Integer |
#public_notepad ⇒ String
Returns public notepad (shown in My.SCOUT) for the event.
43 |
# File 'lib/osm/event.rb', line 43 attribute :id, :type => Integer |
#reminders ⇒ Boolean
Returns whether email reminders are sent for the event.
43 |
# File 'lib/osm/event.rb', line 43 attribute :id, :type => Integer |
#section_id ⇒ Fixnum
Returns the id for the section.
43 |
# File 'lib/osm/event.rb', line 43 attribute :id, :type => Integer |
#start ⇒ DateTime
Returns when the event starts.
43 |
# File 'lib/osm/event.rb', line 43 attribute :id, :type => Integer |
Class Method Details
.create(api, parameters) ⇒ Osm::Event?
Create an event in OSM
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
# File 'lib/osm/event.rb', line 147 def self.create(api, parameters) require_ability_to(api, :write, :events, parameters[:section_id]) event = new(parameters) raise Osm::ObjectIsInvalid, 'event is invalid' unless event.valid? data = api.perform_query("events.php?action=addEvent§ionid=#{event.section_id}", { 'name' => event.name, 'location' => event.location, 'startdate' => event.start? ? event.start.strftime(Osm::OSM_DATE_FORMAT) : '', 'enddate' => event.finish? ? event.finish.strftime(Osm::OSM_DATE_FORMAT) : '', 'cost' => event.cost_tbc? ? '-1' : event.cost, 'notes' => event.notes, 'starttime' => event.start? ? event.start.strftime(Osm::OSM_TIME_FORMAT) : '', 'endtime' => event.finish? ? event.finish.strftime(Osm::OSM_TIME_FORMAT) : '', 'confdate' => event.confirm_by_date? ? event.confirm_by_date.strftime(Osm::OSM_DATE_FORMAT) : '', 'allowChanges' => event.allow_changes ? 'true' : 'false', 'disablereminders' => !event.reminders ? 'true' : 'false', 'attendancelimit' => event.attendance_limit, 'limitincludesleaders' => event.attendance_limit_includes_leaders ? 'true' : 'false', 'allowbooking' => event.allow_booking ? 'true' : 'false', }) # The cached events for the section will be out of date - remove them cache_delete(api, ['events', event.section_id]) cache_write(api, ['event', event.id], event) if (data.is_a?(Hash) && data.has_key?('id')) event.id = data['id'].to_i return event else return nil end end |
.get(api, section, event_id, options = {}) ⇒ Osm::Event?
Get an event
129 130 131 132 133 134 135 136 137 138 139 140 |
# File 'lib/osm/event.rb', line 129 def self.get(api, section, event_id, ={}) require_ability_to(api, :read, :events, section, ) section_id = section.to_i cache_key = ['event', event_id] if ![:no_cache] && cache_exist?(api, cache_key) return cache_read(api, cache_key) end event_data = api.perform_query("events.php?action=getEvent§ionid=#{section_id}&eventid=#{event_id}") return self.new_event_from_data(event_data) end |
.get_for_section(api, section, options = {}) ⇒ Array<Osm::Event>
Get events for a section
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
# File 'lib/osm/event.rb', line 89 def self.get_for_section(api, section, ={}) require_ability_to(api, :read, :events, section, ) section_id = section.to_i cache_key = ['events', section_id] events = nil if ![:no_cache] && cache_exist?(api, cache_key) ids = cache_read(api, cache_key) events = get_from_ids(api, ids, 'event', section, , :get_for_section) end if events.nil? data = api.perform_query("events.php?action=getEvents§ionid=#{section_id}&showArchived=true") events = Array.new ids = Array.new unless data['items'].nil? data['items'].map { |i| i['eventid'].to_i }.each do |event_id| event_data = api.perform_query("events.php?action=getEvent§ionid=#{section_id}&eventid=#{event_id}") event = self.new_event_from_data(event_data) events.push event ids.push event.id cache_write(api, ['event', event.id], event) end end cache_write(api, cache_key, ids) end return events if [:include_archived] return events.reject do |event| event.archived? end end |
Instance Method Details
#<=>(another) ⇒ Object
Compare Event based on start, name then id
356 357 358 359 360 361 362 |
# File 'lib/osm/event.rb', line 356 def <=>(another) return 0 if self.id == another.try(:id) result = self.start <=> another.try(:start) result = self.name <=> another.try(:name) if result == 0 result = self.id <=> another.try(:id) if result == 0 return result end |
#add_column(api, name, label = '') ⇒ Boolean
Add a column to the event in OSM
302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 |
# File 'lib/osm/event.rb', line 302 def add_column(api, name, label='') require_ability_to(api, :write, :events, section_id) raise Osm::ArgumentIsInvalid, 'name is invalid' if name.blank? data = api.perform_query("events.php?action=addColumn§ionid=#{section_id}&eventid=#{id}", { 'columnName' => name, 'parentLabel' => label }) # The cached events for the section will be out of date - remove them cache_delete(api, ['events', section_id]) cache_delete(api, ['event', id]) cache_delete(api, ['event_attendance', id]) self.columns = self.class.new_event_from_data(data).columns return data.is_a?(Hash) && (data['eventid'].to_i == id) end |
#cost_free? ⇒ Boolean
Whether the cost is zero
351 352 353 |
# File 'lib/osm/event.rb', line 351 def cost_free? cost.eql?('0.00') end |
#cost_tbc? ⇒ Boolean
Whether the cost is to be confirmed
345 346 347 |
# File 'lib/osm/event.rb', line 345 def cost_tbc? cost.eql?('TBC') end |
#delete(api) ⇒ Boolean
Delete event from OSM
230 231 232 233 234 235 236 237 238 239 240 |
# File 'lib/osm/event.rb', line 230 def delete(api) require_ability_to(api, :write, :events, section_id) data = api.perform_query("events.php?action=deleteEvent§ionid=#{section_id}&eventid=#{id}") if data.is_a?(Hash) && data['ok'] cache_delete(api, ['event', id]) return true end return false end |
#get_attendance(api, term = nil, options = {}) ⇒ Array<Osm::Event::Attendance>
Get event attendance
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 |
# File 'lib/osm/event.rb', line 249 def get_attendance(api, term=nil, ={}) require_ability_to(api, :read, :events, section_id, ) term_id = term.nil? ? Osm::Term.get_current_term_for_section(api, section_id).id : term.to_i cache_key = ['event_attendance', id] if ![:no_cache] && cache_exist?(api, cache_key) return cache_read(api, cache_key) end data = api.perform_query("events.php?action=getEventAttendance&eventid=#{id}§ionid=#{section_id}&termid=#{term_id}") data = data['items'] || [] payment_values = { 'Manual' => :manual, 'Automatic' => :automatic, } attending_values = { 'Yes' => :yes, 'No' => :no, 'Invited' => :invited, 'Show in My.SCOUT' => :shown, } attendance = [] data.each_with_index do |item, index| attendance.push Osm::Event::Attendance.new( :event => self, :member_id => Osm::to_i_or_nil(item['scoutid']), :grouping_id => Osm::to_i_or_nil(item['patrolid'].eql?('') ? nil : item['patrolid']), :first_name => item['firstname'], :last_name => item['lastname'], :date_of_birth => item['dob'].nil? ? nil : Osm::parse_date(item['dob'], :ignore_epoch => true), :attending => attending_values[item['attending']], :payment_control => payment_values[item['payment']], :fields => item.select { |key, value| key.to_s.match(/\Af_\d+\Z/) } .inject({}){ |h,(k,v)| h[k[2..-1].to_i] = v; h }, :payments => item.select { |key, value| key.to_s.match(/\Ap\d+\Z/) } .inject({}){ |h,(k,v)| h[k[1..-1].to_i] = v; h }, :row => index, ) end cache_write(api, cache_key, attendance) return attendance end |
#limited_attendance? ⇒ Boolean
Whether thete is a limit on attendance for this event
323 324 325 |
# File 'lib/osm/event.rb', line 323 def limited_attendance? (attendance_limit != 0) end |
#spaces(api) ⇒ Fixnum?
Get the number of spaces left for the event
338 339 340 341 |
# File 'lib/osm/event.rb', line 338 def spaces(api) return nil unless limited_attendance? return attendance_limit - attendees(api) end |
#spaces?(api) ⇒ Boolean
Whether there are spaces left for the event
330 331 332 333 |
# File 'lib/osm/event.rb', line 330 def spaces?(api) return true unless limited_attendance? return attendance_limit > attendees(api) end |
#update(api) ⇒ Boolean
Update event in OSM
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 |
# File 'lib/osm/event.rb', line 184 def update(api) require_ability_to(api, :write, :events, section_id) to_update = changed_attributes data = api.perform_query("events.php?action=addEvent§ionid=#{section_id}", { 'eventid' => id, 'name' => name, 'location' => location, 'startdate' => start? ? start.strftime(Osm::OSM_DATE_FORMAT) : '', 'enddate' => finish? ? finish.strftime(Osm::OSM_DATE_FORMAT) : '', 'cost' => cost_tbc? ? '-1' : cost, 'notes' => notes, 'starttime' => start? ? start.strftime(Osm::OSM_TIME_FORMAT) : '', 'endtime' => finish? ? finish.strftime(Osm::OSM_TIME_FORMAT) : '', 'confdate' => confirm_by_date? ? confirm_by_date.strftime(Osm::OSM_DATE_FORMAT) : '', 'allowChanges' => allow_changes ? 'true' : 'false', 'disablereminders' => !reminders ? 'true' : 'false', 'attendancelimit' => attendance_limit, 'limitincludesleaders' => attendance_limit_includes_leaders ? 'true' : 'false', 'allowbooking' => allow_booking ? 'true' : 'false', }) api.perform_query("events.php?action=saveNotepad§ionid=#{section_id}", { 'eventid' => id, 'notepad' => notepad, }) if to_update.include?('notepad') api.perform_query("events.php?action=saveNotepad§ionid=#{section_id}", { 'eventid' => id, 'pnnotepad' => public_notepad, }) if to_update.include?('public_notepad') if data.is_a?(Hash) && (data['id'].to_i == id) reset_changed_attributes # The cached event will be out of date - remove it cache_delete(api, ['event', id]) return true else return false end end |