osm 1.0.6 → 1.2.0

data/CHANGELOG.md

@@ -1,3 +1,33 @@
+## Version 1.2.0
+
+  * Trying to fetch the currrent Term for a Section which doesn;t have one now raises an Osm::Error::NoCurrentTerm instead of an Osm::Error 
+  * Add personal details options to Section:
+    * myscout\_details attribute [Boolean] for whether personal details are enabled
+    * myscout\_details\_expires attribute [Date] for expiry date of subscription
+    * myscout\_details\_email\_changes\_to attribute [String] where to send update emails to
+  * Osm::Member
+    * myscout\_link method now accepts :details to get a link to the "Perosnal details" page
+    * myscout\_link method can now link to a specific event by also passing in the id (optional 3rd parameter)
+    * Addition of myscout\_link\_key method to get the member's unique key for use in myscout links
+  * Osm::Section
+    * subscription\_level\_name method is marked as depricated, ready for removal in version 2.0 -> replace with Osm::SUBSCRIPTION\_LEVEL\_NAMES[section.subscription\_level]
+    * myscout\_programme\_show attribute added - how much of the programme do parents see?
+  * Addition of two new constants:
+    * Osm::SUBSCRIPTION\_LEVEL\_NAMES - an Array of Strings containing the human name of each subscription level (starts with "Unknown" to make indexing work nicely)
+    * Osm::SUBSCRIPTION\_LEVELS - an Array of Symbols for each level (starts with nil to make indexing work nicely)
+  * Register - get\_structure now only includes dates
+  * Addition of attendance\_reminder attribute to event
+  * Abillity to send Sms messages to multiple numbers
+  * Add Gift Aid:
+    * Get Payments
+    * Update Payments
+    * Get Payment/Member Data
+    * Update Payment/Member Data
+  * Add Finances:
+    * Budget (Get, Add, Update, Delete)
+    * Invoices (Get, Add, Update, Delete)
+    * Invoice Items (Get, Add, Update, Delete)
+
 ## Version 1.0.6
 
   * Add badge\_links to Meeting

data/README.md

@@ -32,7 +32,7 @@ Use the [Online Scout Manager](https://www.onlinescoutmanager.co.uk) API.
 Add to your Gemfile and run the `bundle` command to install it.
 
 ```ruby
-gem 'osm', '~> 1.0'
+gem 'osm', '~> 1.2'
 ```
 
 Configure the gem during the initalization of the app (e.g. if using rails then config/initializers/osm.rb would look like):
@@ -90,6 +90,7 @@ however it should be noted that when the OSM API adds a feature it can be diffic
     * Details for each badge
     * Requirements for evening
     * Badge stock levels
+  * Budgets (Gold required)
   * Due Badges
   * Evening
   * Event (Silver required)
@@ -98,7 +99,10 @@ however it should be noted that when the OSM API adds a feature it can be diffic
   * Event Attendance (Silver required)
   * Flexi Record Data
   * Flexi Record Structure
+  * Gift Aid Data
+  * Gift Aid Structure
   * Groupings (e.g. Sixes, Patrols)
+  * Invoices (Gold required)
   * Members
   * Notepad
   * Notepads
@@ -116,39 +120,48 @@ however it should be noted that when the OSM API adds a feature it can be diffic
   * Activity
   * Badges (Silver required for activity, Bronze for core, challenge and staged):
     * Which requirements each member has met
+  * Budget (Gold required)
   * Evening
   * Event (Silver required)
   * Event Attendance (Silver required)
   * Event Column (Silver required)
   * Flexi Record Column
   * Flexi Record Data
+  * Gift Aid Payment
   * Grouping
+  * Invoices (Gold required)
   * Member
   * Register Attendance
 
 ### Create
+  * Budget (Gold required)
   * Evening
   * Event (Silver required)
   * Event Column (Silver required)
-  * Member
   * Flexi Record Column
+  * Gift Aid Payment
+  * Invoices (Gold required)
+  * Member
 
 ### Delete
+  * Budget (Gold required)
   * Evening
   * Event (Silver required)
   * Event Column (Silver required)
   * Flexi Record Column
+  * Invoices (Gold required)
 
 ### Actions
   * Authorise an app to use the API on a user's behalf
   * Add activity to programme
   * Send an SMS to member(s)
 
+## Parts not/never supported
+  * Campsite Directory
 
 ## Parts of the OSM API currently NOT supported (may not be an exhaustive list):
 
 See the [Roadmap page in the wiki](https://github.com/robertgauld/osm/wiki/Roadmap) for more details.
 
-  * Gift aid (Everything) (Gold required) [issue 75]
-  * Finances (Everything) (Gold required) [issues 76 & 77]]
   * MyScout (Everything)
+  * Adult Section Specific Stuff

data/lib/osm.rb

@@ -11,9 +11,10 @@ module Osm
   # Declare exceptions
   class Error < Exception; end
   class ConnectionError < Error; end
-  class Forbidden < Error; end
+  class Forbidden < Osm::Error; end
   class ArgumentIsInvalid < ArgumentError; end
   class ObjectIsInvalid < Error; end
+  class Osm::Error::NoCurrentTerm < Osm::Error; end
 
   private
   # Set constants
@@ -26,6 +27,8 @@ module Osm
   OSM_DATETIME_FORMAT_HUMAN = '%d/%m/%Y %H:%M:%S'
   OSM_TIME_REGEX = /\A(?:[0-1][0-9]|2[0-3]):[0-5][0-9]\Z/
   OSM_DATE_REGEX = /\A(?:[1-9]\d{3}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2][0-9]|3[0-1]))|(?:(?:0?[1-9]|[1-2][0-9]|3[0-1])\/(?:0?[1-9]|1[0-2])\/(?:\d{2}|[1-9]\d{3}))\Z/
+  SUBSCRIPTION_LEVEL_NAMES = ['Unknown', 'Bronze', 'Silver', 'Gold', 'Gold+']
+  SUBSCRIPTION_LEVELS = [nil, :bronze, :silver, :gold, :gold_plus]
 end
 
 # Require file for this gem

data/lib/osm/budget.rb

@@ -0,0 +1,136 @@
+module Osm
+
+  class Budget < Osm::Model
+    # @!attribute [rw] id
+    #   @return [Fixnum] The OSM ID for the budget
+    # @!attribute [rw] section_id
+    #   @return [Fixnum] The OSM ID for the section the budget belongs to
+    # @!attribute [rw] name
+    #   @return [String] The name of the budget
+
+    attribute :id, :type => Integer
+    attribute :section_id, :type => Integer
+    attribute :name, :type => String
+
+    attr_accessible :id, :section_id, :name
+
+    validates_numericality_of :id, :only_integer=>true, :greater_than=>0, :unless => Proc.new { |r| r.id.nil? }
+    validates_numericality_of :section_id, :only_integer=>true, :greater_than=>0
+    validates_presence_of :name
+
+
+    # @!method initialize
+    #   Initialize a new Budget
+    #   @param [Hash] attributes The hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
+
+
+    # Get budgets for a section
+    # @param [Osm::Api] api The api to use to make the request
+    # @param [Osm::Section, Fixnum, #to_i] section The section (or its ID) to get the structure for
+    # @!macro options_get
+    # @return [Array<Osm::Budget>] representing the donations made
+    def self.get_for_section(api, section, options={})
+      Osm::Model.require_ability_to(api, :read, :finance, section, options)
+      section_id = section.to_i
+      cache_key = ['budgets', section_id]
+
+      if !options[:no_cache] && Osm::Model.cache_exist?(api, cache_key)
+        return Osm::Model.cache_read(api, cache_key)
+      end
+
+      data = api.perform_query("finances.php?action=getCategories&sectionid=#{section_id}")
+
+      budgets = []
+      data = data['items']
+      if data.is_a?(Array)
+        data.each do |budget|
+          budgets.push Budget.new(
+            :id => Osm::to_i_or_nil(budget['categoryid']),
+            :section_id => Osm::to_i_or_nil(budget['sectionid']),
+            :name => budget['name'],
+          )
+        end
+      end
+
+      Osm::Model.cache_write(api, cache_key, budgets) unless budgets.nil?
+      return budgets
+    end
+
+
+    # Create the budget in OSM
+    # @param [Osm::Api] api The api to use to make the request
+    # @return [Boolean] whether the budget was created
+    # @raise [Osm::ObjectIsInvalid] If the Budget is invalid
+    # @raise [Osm::Error] If the budget already exists in OSM
+    def create(api)
+      raise Osm::Error, 'the budget already exists in OSM' unless id.nil?
+      raise Osm::ObjectIsInvalid, 'budget is invalid' unless valid?
+      Osm::Model.require_ability_to(api, :write, :finance, section_id)
+
+      data = api.perform_query("finances.php?action=addCategory&sectionid=#{section_id}")
+      if data.is_a?(Hash) && data['ok'].eql?(true)
+        # The cached budgets for the section will be out of date - remove them
+        cache_delete(api, ['budgets', section_id])
+        budgets = Budget.get_for_section(api, section_id, {:no_cache => true})
+        budget = budgets.sort.select{ |b| b.name.eql?('** Unnamed **') }[-1]
+        return false if budget.nil? # a new blank budget was NOT created
+        budget.name = name
+        if budget.update(api)
+          self.id = budget.id
+          return true
+        end
+      end
+      return false
+    end
+
+    # Update budget in OSM
+    # @param [Osm::Api] api The api to use to make the request
+    # @return [Boolean] whether the budget was updated
+    # @raise [Osm::ObjectIsInvalid] If the Budget is invalid
+    def update(api)
+      raise Osm::ObjectIsInvalid, 'budget is invalid' unless valid?
+      Osm::Model.require_ability_to(api, :write, :finance, section_id)
+
+      data = api.perform_query("finances.php?action=updateCategory&sectionid=#{section_id}", {
+        'categoryid' => id,
+        'column' => 'name',
+        'value' => name,
+        'section_id' => section_id,
+        'row' => 0,
+      })
+      if (data.is_a?(Hash) && data['ok'].eql?(true))
+        # The cached budgets for the section will be out of date - remove them
+        cache_delete(api, ['budgets', section_id])
+        return true
+      end
+      return false
+    end
+
+    # Delete budget from OSM
+    # @param [Osm::Api] api The api to use to make the request
+    # @return [Boolean] whether the budget was deleted
+    def delete(api)
+      Osm::Model.require_ability_to(api, :write, :finance, section_id)
+
+      data = api.perform_query("finances.php?action=deleteCategory&sectionid=#{section_id}", {
+        'categoryid' => id,
+      })
+      if (data.is_a?(Hash) && data['ok'].eql?(true))
+        # The cached budgets for the section will be out of date - remove them
+        cache_delete(api, ['budgets', section_id])
+        return true
+      end
+      return false
+    end
+
+
+    # Compare Budget based on section_id then name
+    def <=>(another)
+      result = self.section_id <=> another.try(:section_id)
+      result = self.name <=> another.try(:name) if result == 0
+      return result
+    end
+
+  end # Class Budget
+
+end

data/lib/osm/event.rb

@@ -37,6 +37,8 @@ module Osm
     #   @return [Fixnum] the maximum number of people who can attend the event (0 = no limit)
     # @!attendance [rw] attendance_limit_includes_leaders
     #   @return [Boolean] whether the attendance limit includes leaders
+    # @!attribute [rw] attendance_reminder
+    #   @return [Fixnum] how many days before the event to send a reminder to those attending (0 (off), 1, 3, 7, 14, 21, 28)
     # @!attribute [rw] allow_booking
     #   @return [Boolean] whether booking is allowed through My.SCOUT
 
@@ -57,11 +59,13 @@ module Osm
     attribute :reminders, :type => Boolean, :default => true
     attribute :attendance_limit, :type => Integer, :default => 0
     attribute :attendance_limit_includes_leaders, :type => Boolean, :default => false
+    attribute :attendance_reminder, :type => Integer, :default => 0
     attribute :allow_booking, :type => Boolean, :default => true
 
     attr_accessible :id, :section_id, :name, :start, :finish, :cost, :location, :notes, :archived,
                     :fields, :columns, :notepad, :public_notepad, :confirm_by_date, :allow_changes,
-                    :reminders, :attendance_limit, :attendance_limit_includes_leaders, :allow_booking
+                    :reminders, :attendance_limit, :attendance_limit_includes_leaders,
+                    :attendance_reminder, :allow_booking
 
     validates_numericality_of :id, :only_integer=>true, :greater_than=>0, :allow_nil => true
     validates_numericality_of :section_id, :only_integer=>true, :greater_than=>0
@@ -72,6 +76,7 @@ module Osm
     validates_inclusion_of :reminders, :in => [true, false]
     validates_inclusion_of :attendance_limit_includes_leaders, :in => [true, false]
     validates_inclusion_of :allow_booking, :in => [true, false]
+    validates_inclusion_of :attendance_reminder, :in => [0, 1, 3, 7, 14, 21, 28]
     validates_format_of :cost, :with => /\A(?:\d+\.\d{2}|TBC)\Z/
 
 
@@ -84,7 +89,7 @@ module Osm
     # @param [Osm::Api] api The api to use to make the request
     # @param [Osm::Section, Fixnum, #to_i] section The section (or its ID) to get the events for
     # @!macro options_get
-    # @option options [Boolean] :include_archived (optional) if true then archived activities will also be returned
+    # @option options [Boolean] :include_archived (optional) if true then archived events will also be returned
     # @return [Array<Osm::Event>]
     def self.get_for_section(api, section, options={})
       require_ability_to(api, :read, :events, section, options)
@@ -122,13 +127,13 @@ module Osm
     # Get an event
     # @param [Osm::Api] api The api to use to make the request
     # @param [Osm::Section, Fixnum, #to_i] section The section (or its ID) to get the events for
-    # @param [Fixnum] event_id The id of the event to get
+    # @param [Fixnum, #to_i] 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 self.get(api, section, event_id, options={})
       require_ability_to(api, :read, :events, section, options)
       section_id = section.to_i
+      event_id = event_id.to_i
       cache_key = ['event', event_id]
 
       if !options[:no_cache] && cache_exist?(api, cache_key)
@@ -162,6 +167,7 @@ module Osm
         'allowChanges' => event.allow_changes ? 'true' : 'false',
         'disablereminders' => !event.reminders ? 'true' : 'false',
         'attendancelimit' => event.attendance_limit,
+        'attendancereminder' => event.attendance_reminder,
         'limitincludesleaders' => event.attendance_limit_includes_leaders ? 'true' : 'false',
         'allowbooking' => event.allow_booking ? 'true' : 'false',
       })
@@ -200,6 +206,7 @@ module Osm
         'allowChanges' => allow_changes ? 'true' : 'false',
         'disablereminders' => !reminders ? 'true' : 'false',
         'attendancelimit' => attendance_limit,
+        'attendancereminder' => attendance_reminder,
         'limitincludesleaders' => attendance_limit_includes_leaders ? 'true' : 'false',
         'allowbooking' => allow_booking ? 'true' : 'false',
       })
@@ -392,6 +399,7 @@ module Osm
         :reminders => !event_data['disablereminders'].eql?('1'),
         :attendance_limit => event_data['attendancelimit'].to_i,
         :attendance_limit_includes_leaders => event_data['limitincludesleaders'].eql?('1'),
+        :attendance_reminder => event_data['attendancereminder'].to_i,
         :allow_booking => event_data['allowbooking'].eql?('1'),
       )
 
@@ -403,7 +411,6 @@ module Osm
       end
       event.columns = columns
       return event
-
     end
 
 

data/lib/osm/giftaid.rb

@@ -0,0 +1,292 @@
+module Osm
+
+  class GiftAid
+
+    # Get donations
+    # @param [Osm::Api] api The api to use to make the request
+    # @param [Osm::Section, Fixnum, #to_i] section The section (or its ID) to get the structure for
+    # @param [Osm::Term, Fixnum, #to_i, nil] term The term (or its ID) to get the structure for, passing nil causes the current term to be used
+    # @!macro options_get
+    # @return [Array<Osm::GiftAid::Donation>] representing the donations made
+    def self.get_donations(api, section, term=nil, options={})
+      Osm::Model.require_ability_to(api, :read, :finance, section, options)
+      section_id = section.to_i
+      term_id = term.nil? ? Osm::Term.get_current_term_for_section(api, section).id : term.to_i
+      cache_key = ['gift_aid_donations', section_id, term_id]
+
+      if !options[:no_cache] && Osm::Model.cache_exist?(api, cache_key)
+        return Osm::Model.cache_read(api, cache_key)
+      end
+
+      data = api.perform_query("giftaid.php?action=getStructure&sectionid=#{section_id}&termid=#{term_id}")
+
+      structure = []
+      if data.is_a?(Array)
+        data = (data.size == 2) ? data[1] : []
+        if data.is_a?(Hash) && data['rows'].is_a?(Array)
+          data['rows'].each do |row|
+            structure.push Donation.new(
+              :donation_date => Osm::parse_date(row['field']),
+            )
+          end
+        end
+      end
+
+      Osm::Model.cache_write(api, cache_key, structure) unless structure.nil?
+      return structure
+    end
+
+    # Get donation data
+    # @param [Osm::Api] api The api to use to make the request
+    # @param [Osm::Section, Fixnum, #to_i] section The section (or its ID) to get the register for
+    # @param [Osm::Term, Fixnum, #to_i, nil] term The term (or its ID) to get the register for, passing nil causes the current term to be used
+    # @!macro options_get
+    # @return [Array<Osm::GiftAid::Data>] representing the donations of each member
+    def self.get_data(api, section, term=nil, options={})
+      Osm::Model.require_ability_to(api, :read, :finance, section, options)
+      section_id = section.to_i
+      term_id = term.nil? ? Osm::Term.get_current_term_for_section(api, section).id : term.to_i
+      cache_key = ['gift_aid_data', section_id, term_id]
+
+      if !options[:no_cache] && Osm::Model.cache_exist?(api, cache_key)
+        return Osm::Model.cache_read(api, cache_key)
+      end
+
+      data = api.perform_query("giftaid.php?action=getGrid&sectionid=#{section_id}&termid=#{term_id}")
+
+      to_return = []
+      if data.is_a?(Hash) && data['items'].is_a?(Array)
+        data = data['items']
+        data.each do |item|
+          if item.is_a?(Hash)
+            unless item['scoutid'].to_i < 0  # It's a total row
+              donations = {}
+              item.each do |key, value|
+                if key.match(Osm::OSM_DATE_REGEX)
+                  donations[Osm::parse_date(key)] = value
+                end
+              end
+              to_return.push Osm::GiftAid::Data.new(
+                :member_id => Osm::to_i_or_nil(item['scoutid']),
+                :grouping_id => Osm::to_i_or_nil(item ['patrolid']),
+                :section_id => section_id,
+                :first_name => item['firstname'],
+                :last_name => item['lastname'],
+                :tax_payer_name => item['parentname'],
+                :tax_payer_address => item['address'],
+                :tax_payer_postcode => item['postcode'],
+                :total => item['total'],
+                :donations => donations,
+              )
+            end
+          end
+        end
+        Osm::Model.cache_write(api, cache_key, to_return)
+      end
+      return to_return
+    end
+
+    # Update information for a donation
+    # @param [Hash] data
+    # @option data [Osm::Api] :api The api to use to make the request
+    # @option data [Osm::Section] :section the section to update the register for
+    # @option data [Osm::Term, #to_i, 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 [Fixnum, Array<Fixnum>, Osm::Member, Array<Osm::Member>, #to_i, Array<#to_i>] :members the members (or their ids) to update
+    # @option data [Date, #strftime] :donation_date the date the donation was made
+    # @option data [String, #to_s] :amount the donation amount
+    # @option data [String, #to_s] :note the description for the donation
+    # @return [Boolean] whether the update succedded
+    # @raise [Osm::ArgumentIsInvalid] If data[:section] is missing
+    # @raise [Osm::ArgumentIsInvalid] If data[:donation_date] is missing
+    # @raise [Osm::ArgumentIsInvalid] If data[:amount] is missing
+    # @raise [Osm::ArgumentIsInvalid] If data[:note] is missing
+    # @raise [Osm::ArgumentIsInvalid] If data[:members] is missing
+    # @raise [Osm::ArgumentIsInvalid] If data[:api] is missing
+    def self.update_donation(data={})
+      raise Osm::ArgumentIsInvalid, ':section is missing' if data[:section].nil?
+      raise Osm::ArgumentIsInvalid, ':donation_date is missing' if data[:donation_date].nil?
+      raise Osm::ArgumentIsInvalid, ':amount is missing' if data[:amount].nil?
+      raise Osm::ArgumentIsInvalid, ':note is missing' if data[:note].nil?
+      raise Osm::ArgumentIsInvalid, ':members is missing' if data[:members].nil?
+      raise Osm::ArgumentIsInvalid, ':api is missing' if data[:api].nil?
+      api = data[:api]
+      Osm::Model.require_ability_to(api, :write, :finance, data[:section])
+
+      term_id = data[:term].nil? ? Osm::Term.get_current_term_for_section(api, data[:section]).id : data[:term].to_i
+      section_id = data[:section].to_i
+
+      data[:members] = [*data[:members]].map{ |member| member.to_i.to_s } # Make sure it's an Array of Strings
+
+      response = api.perform_query("giftaid.php?action=update&sectionid=#{section_id}&termid=#{term_id}", {
+        'scouts' => data[:members].inspect,
+        'sectionid' => section_id,
+        'donatedate'=> data[:donation_date].strftime(Osm::OSM_DATE_FORMAT),
+        'amount' => data[:amount],
+        'notes' => data[:note],
+      })
+
+      # The cached donations and data will be out of date - remove them
+      Osm::Model.cache_delete(api, ['gift_aid_donations', section_id, term_id])
+      Osm::Model.cache_delete(api, ['gift_aid_data', section_id, term_id])
+
+      return response.is_a?(Array)
+    end
+
+    class Donation < Osm::Model
+      # @!attribute [rw] donation_date
+      #   @return [Date] When the payment was made
+
+      attribute :donation_date, :type => Date
+
+      attr_accessible :note, :donation_date
+
+      validates_presence_of :donation_date
+
+
+      # @!method initialize
+      #   Initialize a new RegisterField
+      #   @param [Hash] attributes The hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
+
+
+      # Compare Payment based on donation_date then note
+      def <=>(another)
+        return self.donation_date <=> another.try(:donation_date)
+      end
+
+    end # Class GiftAid::Donation
+
+
+    class Data < Osm::Model
+      # @!attribute [rw] member_id
+      #   @return [Fixnum] The OSM ID for the member
+      # @!attribute [rw] grouping_id
+      #   @return [Fixnum] The OSM ID for the member's grouping
+      # @!attribute [rw] section_id
+      #   @return [Fixnum] The OSM ID for the member's section
+      # @!attribute [rw] first_name
+      #   @return [String] The member's first name
+      # @!attribute [rw] last_name
+      #   @return [String] The member's last name
+      # @!attribute [rw] tax_payer_name
+      #   @return [String] The tax payer's name
+      # @!attribute [rw] tax_payer_address
+      #   @return [String] The tax payer's street address
+      # @!attribute [rw] tax_payer_postcode
+      #   @return [String] The tax payer's postcode
+      # @!attribute [rw] total
+      #   @return [String] Total
+      # @!attribute [rw] donations
+      #   @return [DirtyHashy] The data for each payment - keys are the date, values are the value of the payment
+
+      attribute :member_id, :type => Integer
+      attribute :grouping_id, :type => Integer
+      attribute :section_id, :type => Integer
+      attribute :first_name, :type => String
+      attribute :last_name, :type => String
+      attribute :tax_payer_name, :type => String
+      attribute :tax_payer_address, :type => String
+      attribute :tax_payer_postcode, :type => String
+      attribute :total, :type => String
+      attribute :donations, :type => Object, :default => DirtyHashy.new
+
+      attr_accessible :member_id, :first_name, :last_name, :section_id, :grouping_id, :total, :tax_payer_name, :tax_payer_address, :tax_payer_postcode, :donations
+
+      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_numericality_of :section_id, :only_integer=>true, :greater_than=>0
+      validates_presence_of :first_name
+      validates_presence_of :last_name
+
+      validates :donations, :hash => {:key_type => Date, :value_type => String}
+
+
+      # @!method initialize
+      #   Initialize a new registerData
+      #   @param [Hash] attributes The hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
+      # Override initialize to set @orig_attributes
+      old_initialize = instance_method(:initialize)
+      define_method :initialize do |*args|
+        ret_val = old_initialize.bind(self).call(*args)
+        self.donations = DirtyHashy.new(self.donations)
+        self.donations.clean_up!
+        return ret_val
+      end
+
+
+      # Update data in OSM
+      # @param [Osm::Api] api The api to use to make the request
+      # @return [Boolean] whether the data was updated in OSM
+      # @raise [Osm::ObjectIsInvalid] If the Data is invalid
+      def update(api)
+        raise Osm::ObjectIsInvalid, 'data is invalid' unless valid?
+        require_ability_to(api, :write, :finance, section_id)
+        term_id = Osm::Term.get_current_term_for_section(api, section_id).id
+
+        updated = true
+        fields = [
+          ['tax_payer_name', 'parentname', tax_payer_name],
+          ['tax_payer_address', 'address', tax_payer_address],
+          ['tax_payer_postcode', 'postcode', tax_payer_postcode],
+        ]
+        fields.each do |field|
+          if changed_attributes.include?(field[0])
+            result = api.perform_query("giftaid.php?action=updateScout", {
+              'scoutid' => member_id,
+              'termid' => term_id,
+              'column' => field[1],
+              'value' => field[2],
+              'sectionid' => section_id,
+              'row' => 0,
+            })
+            if result.is_a?(Hash)
+              (result['items'] || []).each do |i|
+                if i['scoutid'] == member_id.to_s
+                  updated = false unless i[field[1]] == field[2]
+                end
+              end
+            end
+          end
+        end
+        reset_changed_attributes if updated
+
+        donations.changes.each do |date, (was,now)|
+          date = date.strftime(Osm::OSM_DATE_FORMAT)
+          result = api.perform_query("giftaid.php?action=updateScout", {
+            'scoutid' => member_id,
+            'termid' => term_id,
+            'column' => date,
+            'value' => now,
+            'sectionid' => section_id,
+            'row' => 0,
+          })
+          if result.is_a?(Hash)
+            (result['items'] || []).each do |i|
+              if i['scoutid'] == member_id.to_s
+                updated = false unless i[date] == now
+              end
+            end
+          end
+        end
+        donations.clean_up! if updated
+
+        Osm::Model.cache_delete(api, ['gift_aid_data', section_id, term_id]) if updated
+
+        return updated
+      end
+
+
+      # Compare Data based on section_id, grouping_id, last_name then first_name
+      def <=>(another)
+        result = self.section_id <=> another.try(:section_id)
+        result = self.grouping_id <=> another.try(:grouping_id) if result == 0
+        result = self.last_name <=> another.try(:last_name) if result == 0
+        result = self.first_name <=> another.try(:last_name) if result == 0
+        return result
+      end
+
+    end # Class GiftAid::Data
+
+  end # Class GiftAid
+
+end