osm 0.0.25 → 0.0.26

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+## Version 0.0.26
+
+  * Register - Update attendance
+    * Add api.get\_badge\_requirements\_for\_evening
+    * Add api.update\_register
+  * Event:
+    * Add api.ceate\_event
+    * Add api.update\_event
+    * Add api.delete\_event
+    * Add api.add\_event\_field
+  * Event attendance:
+    * Add api.get\_event
+    * Add api.get\_event\_fields
+    * Add api.get\_event\_attendance
+    * Add api.update\_event\_attendance
+  * Fix "uninitialized constant Osm::Api::HTTParty"
+
 ## Version 0.0.25
 
   * FlexiRecordData, move these attributes to the fields hash:

data/README.md

@@ -71,9 +71,13 @@ however it should be noted that when the OSM API adds a feature it can be diffic
   * Activity
   * API Access
   * API Access for our app
+  * Badge requirements for evening
   * Due Badges
   * Evening
+  * Event
   * Events
+  * Event Fields
+  * Event Attendance
   * Flexi Record Data
   * Flexi Record Structure
   * Groupings (e.g. Sixes, Patrols)
@@ -91,9 +95,16 @@ however it should be noted that when the OSM API adds a feature it can be diffic
 
 ### Update
   * Evening
+  * Event
+  * Event Attendance
+  * Register attendance
 
 ### Create
   * Evening
+  * Event
+
+### Delete
+  * Event
 
 ### Actions
   * Authorise an app to use the API on a user's behalf
@@ -103,26 +114,18 @@ however it should be noted that when the OSM API adds a feature it can be diffic
 
   * Badges:
     * Which requirements each member has met:
-      * Retreive
-      * Update
-    * Retrieve details for each badge (stock, short column names etc.)
-  * Retreival of leader access
-  * Register - Update attendance
+      * Retreive [issue 21]
+      * Update [issue 22]
+    * Retrieve details for each badge (stock, short column names etc.) [issue 20]
   * Flexi Records:
-    * Update data
-    * Add Column
-  * Events:
-    * Attendance (everything)
-    * Add column
-    * Create
-    * Update
+    * Update data [issue 23]
+    * Add Column [issue 24]
   * Member:
-    * Update
-    * Add
-    * Delete
+    * Update [issue 33]
+    * Add [issue 34]
+  * Add activity to programme [issue 35]
+  * Delete Evening [issue 36]
   * Update Activity
-  * Add activity to programme
-  * Delete Evening
   * Gift aid (everything)
   * Finances (Everything)
   * SMS:

data/lib/osm/api.rb

@@ -326,6 +326,25 @@ module Osm
       return result
     end
 
+    # Get the badge requirements met on a specific evening
+    # @param [Osm::Section] section the section to get the pbadge requirements for
+    # @param [Osm::Evening, DateTime, Date] evening the evening (or its date) to get the badge requirements for
+    # @!macro options_get
+    # @return [Array<Hash>] hashes ready to pass into the update_register method
+    def get_badge_requirements_for_evening(section, evening, options={})
+      evening = evening.meeting_date if evening.is_a?(Osm::Evening)
+      cache_key = "badge_requirements-#{section.id}-#{evening.strftime('%Y%m%d')}"
+
+      if !options[:no_cache] && cache_exist?(cache_key) && self.user_can_access?(:programme, section.id)
+        return cache_read(cache_key)
+      end
+
+      data = perform_query("users.php?action=getActivityRequirements&date=#{evening.strftime(Osm::OSM_DATE_FORMAT)}&sectionid=#{section.id}&section=#{section.type}")
+
+      cache_write(cache_key, data, :expires_in => @@default_cache_ttl)
+      return data
+    end
+
     # Get activity details
     # @param [Fixnum] activity_id the activity ID
     # @param [Fixnum] version the version of the activity to retreive, if nil the latest version will be assumed
@@ -448,21 +467,22 @@ module Osm
       cache_key = "events-#{section_id}"
       events = nil
 
-      if !options[:no_cache] && cache_exist?(cache_key) && self.user_can_access?(:programme, section_id, api_data)
-        events = cache_read(cache_key)
-      else
+      if !options[:no_cache] && cache_exist?(cache_key) && self.user_can_access?(:events, section_id, api_data)
+        return cache_read(cache_key)
+      end
 
-        data = perform_query("events.php?action=getEvents&sectionid=#{section_id}&showArchived=true", api_data)
+      data = perform_query("events.php?action=getEvents&sectionid=#{section_id}&showArchived=true", api_data)
 
-        events = Array.new
-        unless data['items'].nil?
-          data['items'].each do |item|
-            events.push Osm::Event.from_api(item)
-          end
+      events = Array.new
+      unless data['items'].nil?
+        data['items'].each do |item|
+          event = Osm::Event.from_api(item)
+          events.push event
+          cache_write("event-#{section_id}-#{event.id}", event, :expires_in => @@default_cache_ttl)
         end
-        self.user_can_access :programme, section_id, api_data
-        cache_write(cache_key, events, :expires_in => @@default_cache_ttl)
       end
+      self.user_can_access :events, section_id, api_data
+      cache_write(cache_key, events, :expires_in => @@default_cache_ttl)
 
       return events if options[:include_archived]
       return events.reject do |event|
@@ -470,6 +490,82 @@ module Osm
       end
     end
 
+    # Get event
+    # @param [Osm::Section, Fixnum] section the section (or its ID) to get the events for
+    # @param [Fixnum] event_id the id of the event to get
+    # @!macro options_get
+    # @option options [Boolean] :include_archived (optional) if true then archived activities will also be returned
+    # @return [Osm::Event, nil] the event (or nil if it couldn't be found
+    def get_event(section, event_id, options={})
+      section_id = id_for_section(section)
+      cache_key = "event-#{section_id}-#{event_id}"
+
+      if !options[:no_cache] && cache_exist?(cache_key) && self.user_can_access?(:events, section_id)
+        return cache_read(cache_key)
+      end
+
+      events = get_events(section, options)
+      return nil unless events.is_a? Array
+
+      events.each do |event|
+        return event if event.id == event_id
+      end
+
+      return nil
+    end
+
+    # Get event fields
+    # @param [Osm::Event, Fixnum] event the event to get the fieldss for
+    # @param [Osm::Term, Fixnum, nil] term the term (or its ID) to get the members for, passing nil causes the current term to be used
+    # @!macro options_get
+    # @option options [Boolean] :include_archived (optional) if true then archived activities will also be returned
+    # @return [Hash] fields of data assigned to the event (keys is the id, value is the field names)
+    def get_event_fields(event, term=nil, options={})
+      term_id = id_for_term(term, event.section_id)
+      cache_key = "event-fields-#{event.section_id}-#{event.id}"
+
+      if !options[:no_cache] && cache_exist?(cache_key) && self.user_can_access?(:events, event.section_id)
+        return cache_read(cache_key)
+      end
+
+      data = perform_query("events.php?action=getEvent&sectionid=#{event.section_id}&eventid=#{event.id}")
+
+      fields = {}
+      ActiveSupport::JSON.decode(data['config']).each do |field|
+        fields[field['id']] = field['name']
+      end
+
+      self.user_can_access :events, event.section_id
+      cache_write(cache_key, fields, :expires_in => @@default_cache_ttl)
+      return fields
+    end
+
+    # Get event attendance
+    # @param [Osm::Event] event the event to get the fieldss for
+    # @param [Osm::Term, Fixnum, nil] term the term (or its ID) to get the members for, passing nil causes the current term to be used
+    # @!macro options_get
+    # @option options [Boolean] :include_archived (optional) if true then archived activities will also be returned
+    # @return [Hash] fields of data assigned to the event (keys is the id, value is the field names)
+    def get_event_attendance(event, term=nil, options={})
+      term_id = id_for_term(term, event.section_id)
+      cache_key = "event-attendance-#{event.section_id}-#{event.id}"
+
+      if !options[:no_cache] && cache_exist?(cache_key) && self.user_can_access?(:events, event.section_id)
+        return cache_read(cache_key)
+      end
+
+      data = perform_query("events.php?action=getEventAttendance&eventid=#{event.id}&sectionid=#{event.section_id}&termid=#{term_id}")
+      data = data['items']
+
+      to_return = []
+      data.each_with_index do |item, index|
+        to_return.push Osm::EventAttendance.from_api(item, index)
+      end
+      self.user_can_access :events, event.section_id
+      cache_write(cache_key, to_return, :expires_in => @@default_cache_ttl/2)
+      return to_return
+    end
+
     # Get due badges
     # @param [Osm::Section, Fixnum] section the section (or its ID) to get the due badges for
     # @param [Osm::Term, Fixnum, nil] term the term (or its ID) to get the due badges for, passing nil causes the current term to be used
@@ -661,6 +757,93 @@ module Osm
       return data.is_a?(Hash) && (data['result'] == 0)
     end
 
+    # Create an event in OSM
+    # @param [Osm::Event] event the event to add to OSM
+    # @return [Fixnum, nil] the id of the created event, nil if failed
+    def create_event(event)
+      raise ArgumentIsInvalid, 'event is invalid' unless event.valid?
+
+      data = perform_query("events.php?action=addEvent&sectionid=#{event.section_id}", {
+        'name' => event.name,
+        'location' => event.location,
+        'startdate' => event.start.strftime(Osm::OSM_DATE_FORMAT),
+        'enddate' => event.finish.strftime(Osm::OSM_DATE_FORMAT),
+        'cost' => event.cost,
+        'notes' => event.notes,
+        'starttime' => event.start.strftime(Osm::OSM_TIME_FORMAT),
+        'endtime' => event.finish.strftime(Osm::OSM_TIME_FORMAT),
+      })
+
+      # The cached events for the section will be out of date - remove them
+      get_events(event.section_id).each do |item|
+        cache_delete("event-#{item.section_id}-#{item.id}")
+      end
+      cache_delete("events-#{event.section_id}")
+
+      return data.is_a?(Hash) ? data['id'] : nil
+    end
+
+    # Update an event in OSM
+    # @param [Osm::Event] event the event to update in OSM
+    # @return [Boolean] wether the update succedded
+    def update_event(event)
+      raise ArgumentIsInvalid, 'event is invalid' unless event.valid?
+
+      data = perform_query("events.php?action=addEvent&sectionid=#{event.section_id}", {
+        'eventid' => event.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,
+        'notes' => event.notes,
+        'starttime' => event.start? ? event.start.strftime(Osm::OSM_TIME_FORMAT) : '',
+        'endtime' => event.finish? ? event.finish.strftime(Osm::OSM_TIME_FORMAT) : '',
+      })
+
+      # The cached events for the section will be out of date - remove them
+      get_events(event.section_id).each do |item|
+        cache_delete("event-#{item.section_id}-#{item.id}")
+      end
+      cache_delete("events-#{event.section_id}")
+
+      return data.is_a?(Hash) && (data['id'].to_i == event.id)
+    end
+
+    # Delete an event from OSM
+    # @param [Osm::Event] event the event to delete from OSM
+    # @return [Boolean] wether the delete succedded
+    def delete_event(event)
+      raise ArgumentIsInvalid, 'event is invalid' unless event.valid?
+
+      data = perform_query("events.php?action=deleteEvent&sectionid=#{event.section_id}&eventid=#{event.id}", {})
+
+      # The cached events for the section will be out of date - remove them
+      cache_delete("event-#{event.section_id}-#{event.id}")
+      cache_delete("events-#{event.section_id}")
+
+      return data.is_a?(Hash) ? data['ok'] : false
+    end
+
+    # Add a field to an Event in OSM
+    # @param [Osm::Event] event the event to update in OSM
+    # @param [String] field_label the label for the field to add
+    # @return [Boolean] wether the update succedded
+    def add_event_field(event, field_label)
+      raise ArgumentIsInvalid, 'event is invalid' unless event.valid?
+      raise ArgumentIsInvalid, 'field_label is invalid' if field_label.blank?
+
+      data = perform_query("events.php?action=addColumn&sectionid=#{event.section_id}&eventid=#{event.id}", {
+        'columnName' => field_label
+      })
+
+      # The cached events for the section will be out of date - remove them
+      cache_delete("event-fields-#{event.section_id}-#{event.id}")
+      cache_delete("event-attendance-#{event.section_id}-#{event.id}")
+
+      return data.is_a?(Hash) && (data['eventid'].to_i == event.id)
+    end
+
     # Create a term in OSM
     # @param [Hash] options - the configuration of the new term
     #   @option options [Osm::Section, Fixnum] :section (required) section or section_id to add the term to
@@ -711,6 +894,42 @@ module Osm
       return response.is_a?(Hash) && (response['result'] == 0)
     end
 
+
+    # Update register for an evening in OSM
+    # @param [Hash] data
+    # @option data [Osm::Section] :section the section to update the register for
+    # @option data [Osm::Term, Fixnum, nil] :term the term (or its ID) to get the register for, passing nil causes the current term to be used
+    # @option data [Osm::Evening, DateTime, Date] :evening the evening to update the register on
+    # @option data [String] :attendance what to mark the attendance as, one of "Yes", "No" or "Absent"
+    # @option data [Fixnum, Array<Fixnum>, Osm::Member, Array<Osm::Member>] :members the members (or their ids) to update
+    # @option data [Array<Hash>] :completed_badge_requirements (optional) the badge requirements to mark as completed, selected from the Hash returned by the get_badge_requirements_for_evening method
+    # @return [Boolean] wether the update succedded
+    def update_register(data={})
+      raise ArgumentIsInvalid, ':attendance is invalid' unless ['Yes', 'No', 'Absent'].include?(data[:attendance])
+      raise ArgumentIsInvalid, ':section is missing' if data[:section].nil?
+      raise ArgumentIsInvalid, ':evening is missing' if data[:evening].nil?
+      raise ArgumentIsInvalid, ':members is missing' if data[:members].nil?
+
+      term_id = id_for_term(data[:term], data[:section])
+
+      data[:members] = [data[:members]] unless data[:members].is_a?(Array)    # Make sure it's an Array
+      data[:members] = data[:members].map{ |member| (member.is_a?(Fixnum) ? member : member.id).to_s } # Make sure it's an Array of Strings
+
+      response = perform_query("users.php?action=registerUpdate&sectionid=#{data[:section].id}&termid=#{term_id}", {
+        'scouts' => data[:members].inspect,
+        'selectedDate' => data[:evening].strftime(Osm::OSM_DATE_FORMAT),
+        'present' => data[:attendance],
+        'section' => data[:section].type,
+        'sectionid' => data[:section].id,
+        'completedBadges' => (data[:completed_badge_requirements] || []).to_json
+      })
+
+      # The cached attendance will be out of date - remove them
+      cache_delete("register-#{data[:section].id}-#{term_id}")
+
+      return response.is_a?(Array)
+    end
+
     # Update a term in OSM
     # @param [Osm::Term] term the term to update
     # @return [Boolean] if the operation suceeded or not
@@ -725,6 +944,31 @@ module Osm
 
       return data.is_a?(Hash) && data['terms'].is_a?(Hash)
     end
+
+    # Update event attendance
+    # @param [Osm::Event] event the event to update the attendance of
+    # @param [Osm::EventAttendance] event_attendance the attendance record to update
+    # @param [String] field_id the id of the field to update (must be 'attending' or /\Af_\d+\Z/)
+    # @return [Boolean] if the operation suceeded or not
+    def update_event_attendance(event, event_attendance, field_id)
+      raise ArgumentIsInvalid, 'event is invalid' unless event.valid?
+      raise ArgumentIsInvalid, 'event_attendance is invalid' unless event_attendance.valid?
+      raise ArgumentIsInvalid, 'field_id is invalid' unless field_id.match(/\Af_\d+\Z/) || field_id.eql?('attending')
+
+      data = perform_query("events.php?action=updateScout", {
+        'scoutid' => event_attendance.member_id,
+        'column' => field_id,
+        'value' => !field_id.eql?('attending') ? event_attendance.fields[field_id] : (event_attendance.fields['attending'] ? 'Yes' : 'No'),
+        'sectionid' => event.section_id,
+        'row' => event_attendance.row,
+        'eventid' => event.id,
+      })
+
+      # The cached event attedance will be out of date
+      cache_delete("event-attendance-#{event.section_id}-#{event.id}")
+
+      return data.is_a?(Hash)
+    end
   
   
 

data/lib/osm/event.rb

@@ -21,6 +21,7 @@ module Osm
     # @!attribute [rw] notes
     #   @return [String] notes about the event
     # @!attribute [rw] archived
+    #   @return [Boolean] if the event has been archived
 
     attribute :id, :type => Integer
     attribute :section_id, :type => Integer
@@ -34,7 +35,7 @@ module Osm
 
     attr_accessible :id, :section_id, :name, :start, :finish, :cost, :location, :notes, :archived
 
-    validates_numericality_of :id, :only_integer=>true, :greater_than=>0
+    validates_numericality_of :id, :only_integer=>true, :greater_than=>0, :allow_nil => true
     validates_numericality_of :section_id, :only_integer=>true, :greater_than=>0
     validates_presence_of :name
 
@@ -55,7 +56,7 @@ module Osm
         :cost => data['cost'],
         :location => data['location'],
         :notes => data['notes'],
-        :archived => data['archived'].eql?('1')
+        :archived => data['archived'].eql?('1'),
       })
     end
 

data/lib/osm/event_attendance.rb

@@ -0,0 +1,55 @@
+module Osm
+
+  class EventAttendance
+    include ::ActiveAttr::MassAssignmentSecurity
+    include ::ActiveAttr::Model
+
+    # @!attribute [rw] member_id
+    #   @return [Fixnum] OSM id for the member
+    # @!attribute [rw] grouping__id
+    #   @return [Fixnum] OSM id for the grouping the member is in
+    # @!attribute [rw] fields
+    #   @return [Hash] Keys are the field's id, values are the field values
+    # @!attribute [rw] row
+    #   @return [Fixnum] part of the OSM API
+
+    attribute :row, :type => Integer
+    attribute :member_id, :type => Integer
+    attribute :grouping_id, :type => Integer
+    attribute :fields, :default => {}
+
+    attr_accessible :member_id, :grouping_id, :fields, :row
+
+    validates_numericality_of :row, :only_integer=>true, :greater_than_or_equal_to=>0
+    validates_numericality_of :member_id, :only_integer=>true, :greater_than=>0
+    validates_numericality_of :grouping_id, :only_integer=>true, :greater_than_or_equal_to=>-2
+    validates :fields, :hash => {:key_type => String}
+
+
+    # @!method initialize
+    #   Initialize a new FlexiRecordData
+    #   @param [Hash] attributes the hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
+
+
+    # Initialize a new FlexiRecordData from api data
+    # @param [Hash] data the hash of data provided by the API
+    # @param [Fixnum] row part of the OSM API
+    def self.from_api(data, row)
+      data.merge!({
+        'dob' => data['dob'].nil? ? nil : Osm::parse_date(data['dob'], :ignore_epoch => true),
+        'attending' => data['attending'].eql?('Yes'),
+      })
+
+      new({
+        :member_id => Osm::to_i_or_nil(data['scoutid']),
+        :grouping_id => Osm::to_i_or_nil(data['patrolid'].eql?('') ? nil : data['patrolid']),
+        :fields => data.select { |key, value|
+          ['firstname', 'lastname', 'dob', 'attending'].include?(key) || key.to_s.match(/\Af_\d+\Z/)
+        },
+        :row => row,
+      })
+    end
+
+  end # Class EventAttendance
+
+end # Module

data/lib/osm/flexi_record_data.rb

@@ -9,7 +9,7 @@ module Osm
     # @!attribute [rw] grouping__id
     #   @return [Fixnum] OSM id for the grouping the member is in
     # @!attribute [rw] fields
-    #   @return [Hash] Keys are the field'd id, values are the field values
+    #   @return [Hash] Keys are the field's id, values are the field values
 
     attribute :member_id, :type => Integer
     attribute :grouping_id, :type => Integer
@@ -41,7 +41,7 @@ module Osm
         :member_id => Osm::to_i_or_nil(data['scoutid']),
         :grouping_id => Osm::to_i_or_nil(data['patrolid'].eql?('') ? nil : data['patrolid']),
         :fields => data.select { |key, value|
-          ['firstname', 'lastname', 'dob', 'total', 'completed', 'age'].include?(key) || key.to_s.match(/^f_\d+/)
+          ['firstname', 'lastname', 'dob', 'total', 'completed', 'age'].include?(key) || key.to_s.match(/\Af_\d+\Z/)
         }
       })
     end

data/lib/osm.rb

@@ -1,9 +1,14 @@
 require 'active_attr'
+require 'active_support'
+require 'active_model'
 require 'date'
+require 'httparty'
+
 
 module Osm
   OSM_EPOCH_S = '1970-01-01'
   OSM_DATE_FORMAT = '%Y-%m-%d'
+  OSM_TIME_FORMAT = '%H:%M:%S'
   OSM_DATETIME_FORMAT = '%Y-%m-%d %H:%M:%S'
   OSM_TIME_REGEX = /\A(?:[0-1][0-9]|2[0-3]):[0-5][0-9]\Z/
   OSM_DATE_REGEX = /\A\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1])\Z/
@@ -59,6 +64,16 @@ module Osm
     end
   end
 
+  def self.parse_date_time(date_time)
+    return nil if date_time.nil? || date_time.empty?
+    begin
+      return DateTime.strptime((date_time), OSM_DATETIME_FORMAT)
+    rescue ArgumentError
+      return nil
+    end
+  end
+
+
   def self.parse_date(date, options={})
     return nil if date.nil? || date.empty? || (date.eql?(OSM_EPOCH_S) && !options[:ignore_epoch])
     begin

data/spec/osm/api_spec.rb

@@ -346,6 +346,165 @@ describe "API" do
       events[0].id.should == 1
     end
 
+    it "Fetch an event" do
+      body = {
+        'identifier' => 'eventid',
+        'label' => 'name',
+        'items' => [{
+          'eventid' => '2',
+          'name' => 'An Event',
+          'startdate' => '2001-02-03',
+          'enddate' => nil,
+          'starttime' => '00:00:00',
+          'endtime' => '00:00:00',
+          'cost' => '0.00',
+          'location' => '',
+          'notes' => '',
+          'sectionid' => 1,
+          'googlecalendar' => nil,
+          'archived' => '0'
+        }]
+      }
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/events.php?action=getEvents&sectionid=1&showArchived=true", :body => body.to_json)
+      event = Osm::Api.new('1', '2').get_event(1, 2)
+      event.id.should == 2
+    end
+
+    it "Fetch an event's fields" do
+      events_body = {
+        'identifier' => 'eventid',
+        'label' => 'name',
+        'items' => [{
+          'eventid' => '2',
+          'name' => 'An Event',
+          'startdate' => '2001-02-03',
+          'enddate' => nil,
+          'starttime' => '00:00:00',
+          'endtime' => '00:00:00',
+          'cost' => '0.00',
+          'location' => '',
+          'notes' => '',
+          'sectionid' => 1,
+          'googlecalendar' => nil,
+          'archived' => '0'
+        }]
+      }
+      fields_body = {
+        'config' => '[{"id":"f_1","name":"Field 1"}]'
+      }
+
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/events.php?action=getEvents&sectionid=1&showArchived=true", :body => events_body.to_json)
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/events.php?action=getEvent&sectionid=1&eventid=2", :body => fields_body.to_json)
+      api = Osm::Api.new('1', '2')
+
+      fields = api.get_event_fields(api.get_event(1, 2), 3)
+      fields.should == {'f_1' => 'Field 1'}
+    end
+
+    it "Fetch an event's attendance" do
+      events_body = {
+        'identifier' => 'eventid',
+        'label' => 'name',
+        'items' => [{
+          'eventid' => '2',
+          'name' => 'An Event',
+          'startdate' => '2001-02-03',
+          'enddate' => nil,
+          'starttime' => '00:00:00',
+          'endtime' => '00:00:00',
+          'cost' => '0.00',
+          'location' => '',
+          'notes' => '',
+          'sectionid' => 1,
+          'googlecalendar' => nil,
+          'archived' => '0'
+        }]
+      }
+      attendance_body = {
+	'identifier' => 'scoutid',
+	'eventid' => '2',
+	'items' => [
+          {
+	    'scoutid' => '1',
+	    'attending' => 'Yes',
+            'firstname' => 'First',
+            'lastname' => 'Last',
+            'dob' => '1980-01-02',
+            'patrolid' => '2',
+            'f_1' => '',
+          }
+        ]
+      }
+
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/events.php?action=getEvents&sectionid=1&showArchived=true", :body => events_body.to_json)
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/events.php?action=getEventAttendance&eventid=2&sectionid=1&termid=3", :body => attendance_body.to_json)
+      api = Osm::Api.new('1', '2')
+
+      attendance = api.get_event_attendance(api.get_event(1, 2), 3)
+      attendance.is_a?(Array).should be_true
+    end
+
+    it "Update an event's attendance" do
+      events_body = {
+        'identifier' => 'eventid',
+        'label' => 'name',
+        'items' => [{
+          'eventid' => '2',
+          'name' => 'An Event',
+          'startdate' => '2001-02-03',
+          'enddate' => nil,
+          'starttime' => '00:00:00',
+          'endtime' => '00:00:00',
+          'cost' => '0.00',
+          'location' => '',
+          'notes' => '',
+          'sectionid' => 1,
+          'googlecalendar' => nil,
+          'archived' => '0'
+        }]
+      }
+      attendance_body = {
+	'identifier' => 'scoutid',
+	'eventid' => '2',
+	'items' => [
+          {
+	    'scoutid' => '1',
+	    'attending' => 'Yes',
+            'firstname' => 'First',
+            'lastname' => 'Last',
+            'dob' => '1980-01-02',
+            'patrolid' => '2',
+            'f_1' => '',
+          }
+        ]
+      }
+
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/events.php?action=getEvents&sectionid=1&showArchived=true", :body => events_body.to_json)
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/events.php?action=getEventAttendance&eventid=2&sectionid=1&termid=3", :body => attendance_body.to_json)
+
+      api = Osm::Api.new('1', '2')
+      e = api.get_event(1, 2)
+      ea = api.get_event_attendance(e, 3)[0]
+      ea.fields['f_1'] = 'TEST'
+
+      HTTParty.should_receive(:post).with(
+        "https://www.onlinescoutmanager.co.uk/events.php?action=updateScout",
+        {:body => {
+          'scoutid' => 1,
+          'column' => 'f_1',
+          'value' => 'TEST',
+          'sectionid' => 1,
+          'row' => 0,
+          'eventid' => 2,
+          'apiid' => '1',
+          'token' => 'API TOKEN',
+          'userid' => '1',
+          'secret' => '2',
+        }}
+      ) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'{}'}) }
+      api.update_event_attendance(e, ea, 'f_1').should be_true
+    end
+
     it "Fetch events for a section honoring archived option" do
       body = {
         'identifier' => 'eventid',
@@ -401,6 +560,17 @@ describe "API" do
     end
 
 
+    it "Fetch badge requirements for an evening" do
+      badges_body = [{'a'=>'a'},{'a'=>'A'}]
+      FakeWeb.register_uri(:post, 'https://www.onlinescoutmanager.co.uk/users.php?action=getActivityRequirements&date=2000-01-02&sectionid=3&section=cubs', :body => badges_body.to_json)
+
+      section = Osm::Section.new(:id => 3, :type => :cubs)
+      evening = Date.new(2000, 1, 2)
+
+      Osm::Api.new('1', '2').get_badge_requirements_for_evening(section, evening).should == badges_body
+    end
+
+
     it "Fetch badge stock levels for a section" do
       badges_body = {
         'stock' => {
@@ -587,6 +757,217 @@ describe "API" do
     end
 
 
+    it "Create an event (succeded)" do
+      url = 'https://www.onlinescoutmanager.co.uk/events.php?action=addEvent&sectionid=1'
+      post_data = {
+        'apiid' => @api_config[:api_id],
+        'token' => @api_config[:api_token],
+        'userid' => 'user',
+        'secret' => 'secret',
+        'name' => 'Test event',
+        'startdate' => '2000-01-02',
+        'enddate' => '2001-02-03',
+        'starttime' => '03:04:05',
+        'endtime' => '04:05:06',
+        'cost' => '1.23',
+        'location' => 'Somewhere',
+        'notes' => 'none'
+      }
+
+      api = Osm::Api.new('user', 'secret')
+      api.stub(:get_events) { [] }
+      HTTParty.should_receive(:post).with(url, {:body => post_data}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"id":2}'}) }
+
+      api.create_event(Osm::Event.new({
+        :section_id => 1,
+        :name => 'Test event',
+        :start => DateTime.new(2000, 01, 02, 03, 04, 05),
+        :finish => DateTime.new(2001, 02, 03, 04, 05, 06),
+        :cost => '1.23',
+        :location => 'Somewhere',
+        :notes => 'none'
+      })).should == 2
+    end
+
+    it "Create an event (failed)" do
+      url = 'https://www.onlinescoutmanager.co.uk/events.php?action=addEvent&sectionid=1'
+      post_data = {
+        'apiid' => @api_config[:api_id],
+        'token' => @api_config[:api_token],
+        'userid' => 'user',
+        'secret' => 'secret',
+        'name' => 'Test event',
+        'startdate' => '2000-01-02',
+        'enddate' => '2001-02-03',
+        'starttime' => '03:04:05',
+        'endtime' => '04:05:06',
+        'cost' => '1.23',
+        'location' => 'Somewhere',
+        'notes' => 'none'
+      }
+
+      api = Osm::Api.new('user', 'secret')
+      api.stub(:get_events) { [] }
+      HTTParty.should_receive(:post).with(url, {:body => post_data}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'{}'}) }
+
+      api.create_event(Osm::Event.new({
+        :section_id => 1,
+        :name => 'Test event',
+        :start => DateTime.new(2000, 01, 02, 03, 04, 05),
+        :finish => DateTime.new(2001, 02, 03, 04, 05, 06),
+        :cost => '1.23',
+        :location => 'Somewhere',
+        :notes => 'none'
+      })).should be_nil
+    end
+
+    it "Update an event (succeded)" do
+      url = 'https://www.onlinescoutmanager.co.uk/events.php?action=addEvent&sectionid=1'
+      post_data = {
+        'apiid' => @api_config[:api_id],
+        'token' => @api_config[:api_token],
+        'userid' => 'user',
+        'secret' => 'secret',
+        'name' => 'Test event',
+        'startdate' => '2000-01-02',
+        'enddate' => '2001-02-03',
+        'starttime' => '03:04:05',
+        'endtime' => '04:05:06',
+        'cost' => '1.23',
+        'location' => 'Somewhere',
+        'notes' => 'none',
+        'eventid' => 2
+      }
+
+      api = Osm::Api.new('user', 'secret')
+      api.stub(:get_events) { [] }
+      HTTParty.should_receive(:post).with(url, {:body => post_data}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"id":2}'}) }
+
+      api.update_event(Osm::Event.new({
+        :section_id => 1,
+        :name => 'Test event',
+        :start => DateTime.new(2000, 01, 02, 03, 04, 05),
+        :finish => DateTime.new(2001, 02, 03, 04, 05, 06),
+        :cost => '1.23',
+        :location => 'Somewhere',
+        :notes => 'none',
+        :id => 2
+      })).should be_true
+    end
+
+    it "Update an event (failed)" do
+      url = 'https://www.onlinescoutmanager.co.uk/events.php?action=addEvent&sectionid=1'
+      post_data = {
+        'apiid' => @api_config[:api_id],
+        'token' => @api_config[:api_token],
+        'userid' => 'user',
+        'secret' => 'secret',
+        'name' => 'Test event',
+        'startdate' => '2000-01-02',
+        'enddate' => '2001-02-03',
+        'starttime' => '03:04:05',
+        'endtime' => '04:05:06',
+        'cost' => '1.23',
+        'location' => 'Somewhere',
+        'notes' => 'none',
+        'eventid' => 2
+      }
+
+      api = Osm::Api.new('user', 'secret')
+      api.stub(:get_events) { [] }
+      HTTParty.should_receive(:post).with(url, {:body => post_data}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'{}'}) }
+
+      api.update_event(Osm::Event.new({
+        :section_id => 1,
+        :name => 'Test event',
+        :start => DateTime.new(2000, 01, 02, 03, 04, 05),
+        :finish => DateTime.new(2001, 02, 03, 04, 05, 06),
+        :cost => '1.23',
+        :location => 'Somewhere',
+        :notes => 'none',
+        :id => 2
+      })).should be_false
+    end
+
+    it "Delete an event (succeded)" do
+      url = 'https://www.onlinescoutmanager.co.uk/events.php?action=deleteEvent&sectionid=1&eventid=2'
+      post_data = {
+        'apiid' => @api_config[:api_id],
+        'token' => @api_config[:api_token],
+        'userid' => 'user',
+        'secret' => 'secret',
+      }
+
+      api = Osm::Api.new('user', 'secret')
+      HTTParty.should_receive(:post).with(url, {:body => post_data}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"ok":true}'}) }
+
+      api.delete_event(Osm::Event.new({
+        :section_id => 1,
+        :name => 'Test event',
+        :id => 2
+      })).should be_true
+    end
+
+    it "Delete an event (failed)" do
+      url = 'https://www.onlinescoutmanager.co.uk/events.php?action=deleteEvent&sectionid=1&eventid=2'
+      post_data = {
+        'apiid' => @api_config[:api_id],
+        'token' => @api_config[:api_token],
+        'userid' => 'user',
+        'secret' => 'secret',
+      }
+
+      api = Osm::Api.new('user', 'secret')
+      HTTParty.should_receive(:post).with(url, {:body => post_data}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"ok":false}'}) }
+
+      api.delete_event(Osm::Event.new({
+        :section_id => 1,
+        :name => 'Test event',
+        :id => 2
+      })).should be_false
+    end
+
+    it "Add field to an event (succeded)" do
+      url = 'https://www.onlinescoutmanager.co.uk/events.php?action=addColumn&sectionid=1&eventid=2'
+      post_data = {
+        'apiid' => @api_config[:api_id],
+        'token' => @api_config[:api_token],
+        'userid' => 'user',
+        'secret' => 'secret',
+        'columnName' => 'Test field',
+      }
+
+      api = Osm::Api.new('user', 'secret')
+      HTTParty.should_receive(:post).with(url, {:body => post_data}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"eventid":"2"}'}) }
+
+      api.add_event_field(Osm::Event.new({
+        :section_id => 1,
+        :name => 'Test event',
+        :id => 2
+      }), 'Test field').should be_true
+    end
+
+    it "Add field to an event (failed)" do
+      url = 'https://www.onlinescoutmanager.co.uk/events.php?action=addColumn&sectionid=1&eventid=2'
+      post_data = {
+        'apiid' => @api_config[:api_id],
+        'token' => @api_config[:api_token],
+        'userid' => 'user',
+        'secret' => 'secret',
+        'columnName' => 'Test field',
+      }
+
+      api = Osm::Api.new('user', 'secret')
+      HTTParty.should_receive(:post).with(url, {:body => post_data}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'{}'}) }
+
+      api.add_event_field(Osm::Event.new({
+        :section_id => 1,
+        :name => 'Test event',
+        :id => 2
+      }), 'Test field').should be_false
+    end
+
+
     it "Create a term (succeded)" do
       url = 'https://www.onlinescoutmanager.co.uk/users.php?action=addTerm&sectionid=1'
       post_data = {
@@ -637,6 +1018,32 @@ describe "API" do
       }).should be_false
     end
 
+    it "Update register attendance" do
+      url = 'https://www.onlinescoutmanager.co.uk/users.php?action=registerUpdate&sectionid=1&termid=2'
+      post_data = {
+        'apiid' => @api_config[:api_id],
+        'token' => @api_config[:api_token],
+        'userid' => 'user',
+        'secret' => 'secret',
+        'scouts' => '["3"]',
+        'selectedDate' => '2000-01-02',
+        'present' => 'Yes',
+        'section' => :cubs,
+        'sectionid' => 1,
+        'completedBadges' => '[{"a":"A"},{"b":"B"}]'
+      }
+
+      HTTParty.should_receive(:post).with(url, {:body => post_data}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>'[]'}) }
+      Osm::Api.new('user', 'secret').update_register({
+        :section => Osm::Section.new(:id=>1, :type=>:cubs),
+        :term => 2,
+        :evening => Date.new(2000, 1, 2),
+        :attendance => 'Yes',
+        :members => 3,
+        :completed_badge_requirements => [{'a'=>'A'}, {'b'=>'B'}]
+      }).should be_true
+    end
+
 
     it "Update a term (succeded)" do
       url = 'https://www.onlinescoutmanager.co.uk/users.php?action=addTerm&sectionid=1'

data/spec/osm/event_attendance_spec.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'date'
+
+
+describe "Event Attendance" do
+
+  it "Create from API data" do
+    data = {
+      "scoutid" => "1",
+      "firstname" => "First",
+      "lastname" => "Last",
+      "dob" => "1899-11-30",
+      "patrolid" => "2",
+      "f_1" => "a",
+      "attending" => "Yes",
+    }
+
+    ea = Osm::EventAttendance.from_api(data, 3)
+
+    ea.member_id.should == 1
+    ea.grouping_id.should == 2
+    ea.fields.should == {
+      'firstname' => 'First',
+      'lastname' => 'Last',
+      'dob' => Date.new(1899, 11, 30),
+      'attending' => true,
+      'f_1' => 'a',
+    }
+    ea.row.should == 3
+    ea.valid?.should be_true
+  end
+
+end

data/spec/osm/event_spec.rb

@@ -16,7 +16,7 @@ describe "Event" do
       'cost' => 'Free',
       'location' => 'Somewhere',
       'notes' => 'None',
-      'archived' => '0'
+      'archived' => '0',
     }
     event = Osm::Event.from_api(data)
 

data/version.rb

@@ -1,3 +1,3 @@
 module Osm
-  VERSION = "0.0.25"
+  VERSION = "0.0.26"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osm
 version: !ruby/object:Gem::Version
-  version: 0.0.25
+  version: 0.0.26
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-26 00:00:00.000000000Z
+date: 2012-10-02 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &83764340 !ruby/object:Gem::Requirement
+  requirement: &84281650 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *83764340
+  version_requirements: *84281650
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &83763040 !ruby/object:Gem::Requirement
+  requirement: &84280940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *83763040
+  version_requirements: *84280940
 - !ruby/object:Gem::Dependency
   name: active_attr
-  requirement: &83762650 !ruby/object:Gem::Requirement
+  requirement: &84277910 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.6'
   type: :runtime
   prerelease: false
-  version_requirements: *83762650
+  version_requirements: *84277910
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &83761810 !ruby/object:Gem::Requirement
+  requirement: &84277570 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *83761810
+  version_requirements: *84277570
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &83759370 !ruby/object:Gem::Requirement
+  requirement: &84277120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *83759370
+  version_requirements: *84277120
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &83745000 !ruby/object:Gem::Requirement
+  requirement: &84276710 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '2.11'
   type: :development
   prerelease: false
-  version_requirements: *83745000
+  version_requirements: *84276710
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &83744610 !ruby/object:Gem::Requirement
+  requirement: &84276320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,7 +87,7 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *83744610
+  version_requirements: *84276320
 description: Use the Online Scout Manager API (https://www.onlinescoutmanager.co.uk)
   to retrieve and save data.
 email:
@@ -113,6 +113,7 @@ files:
 - lib/osm/due_badges.rb
 - lib/osm/evening.rb
 - lib/osm/event.rb
+- lib/osm/event_attendance.rb
 - lib/osm/flexi_record_data.rb
 - lib/osm/flexi_record_field.rb
 - lib/osm/grouping.rb
@@ -129,6 +130,7 @@ files:
 - spec/osm/api_strangeness_spec.rb
 - spec/osm/due_badges_spec.rb
 - spec/osm/evening_spec.rb
+- spec/osm/event_attendance_spec.rb
 - spec/osm/event_spec.rb
 - spec/osm/flexi_record_data_spec.rb
 - spec/osm/flexi_record_field_spec.rb