osm 0.5.0 → 0.6.0

data/CHANGELOG.md

@@ -1,3 +1,19 @@
+## Version 0.6.0
+
+  * Badge::Data
+    * completed attribute is now a Fixnum not Boolean (fixes staged badges)
+    * Add awarded attribute (the last level awarded)
+    * Add due? method to tell if the badge is due
+    * Add started? method to tell if the badge has been started
+    * Add started method to tell which stage has been started
+    * Add first\_name and last\_name attributes
+    * Add mark\_awarded method
+    * Add mark\_due method
+  * Badge
+    * Make get\_badge\_data\_for\_section an instance not class method (called get\_data\_for\_section)
+    * Add get\_summary\_for\_section(api, section, term=nil, options={}) method
+    * Add optional section\_type parameter to get\_badges\_for\_section method
+
 ## Version 0.5.0
 
   * Code breaking changes to DueBadges:

data/README.md

@@ -5,7 +5,7 @@
 ##Build State
 This project uses continuous integration to help ensure that a quality product is delivered.
 Travis CI monitors two branches (versions) of the code - Master (which is what gets released)
-and Staging (which is what is currently being debugged ready for moving to master).
+and Staging (which is what is currently being developed ready for moving to master).
 
 Master [![Build Status](https://secure.travis-ci.org/robertgauld/osm.png?branch=master)](http://travis-ci.org/robertgauld/osm)
 
@@ -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', '~> 0.5.0'
+gem 'osm', '~> 0.6.0'
 ```
 
 Configure the gem during the initalization of the app (e.g. if using rails then config/initializers/osm.rb would look like):

data/lib/osm/badge.rb

@@ -7,7 +7,7 @@ module Osm
     #   @return [String] the name of the badge
     # @!attribute [rw] requirement_notes
     #   @return [String] a description of the badge
-    # @!attribute [rw] key
+    # @!attribute [rw] osm_key
     #   @return [String] the key for the badge in OSM
     # @!attribute [rw] sections_needed
     #   @return [Fixnum]
@@ -45,13 +45,15 @@ module Osm
     # Get badges
     # @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 due badges for
+    # @param [Symbol] section_type The type of section to get badges for (if nil uses the type of the section param)
     # @!macro options_get
     # @return [Array<Osm::Badge>]
-    def self.get_badges_for_section(api, section, options={})
-      raise Error, 'This method must be called on one of the subclasses (CoreBadge, ChallengeBadge, StagedBadge or ActivityBadge)' if badge_type.nil?
+    def self.get_badges_for_section(api, section, section_type=nil, options={})
+      raise Error, 'This method must be called on one of the subclasses (CoreBadge, ChallengeBadge, StagedBadge or ActivityBadge)' if type.nil?
       require_ability_to(api, :read, :badge, section, options)
       section = Osm::Section.get(api, section, options) unless section.is_a?(Osm::Section)
-      cache_key = ['badges', section.type, badge_type]
+      section_type ||= section.type
+      cache_key = ['badges', section_type, type]
 
       if !options[:no_cache] && Osm::Model.cache_exist?(api, cache_key)
         return cache_read(api, cache_key)
@@ -60,7 +62,7 @@ module Osm
       term_id = Osm::Term.get_current_term_for_section(api, section, options).to_i
       badges = []
 
-      data = api.perform_query("challenges.php?action=getInitialBadges&type=#{badge_type}&sectionid=#{section.id}&section=#{section.type}&termid=#{term_id}")
+      data = api.perform_query("challenges.php?action=getInitialBadges&type=#{type}&sectionid=#{section.id}&section=#{section_type}&termid=#{term_id}")
       badge_order = data["badgeOrder"].to_s.split(',')
       structures = data["structure"] || {}
       details = data["details"] || {}
@@ -97,34 +99,70 @@ module Osm
       return badges
     end
 
+    # Get a summary of badges earnt by members
+    # @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 due badges for
+    # @param [Osm::Term, Fixnum, #to_i, nil] term The term (or its ID) to get the due badges for, passing nil causes the current term to be used
+    # @!macro options_get
+    # @return [Array<Hash>]
+    def self.get_summary_for_section(api, section, term=nil, options={})
+      raise Error, 'This method must be called on one of the subclasses (CoreBadge, ChallengeBadge, StagedBadge or ActivityBadge)' if type.nil?
+      require_ability_to(api, :read, :badge, section, options)
+      section = Osm::Section.get(api, section, options) unless section.is_a?(Osm::Section)
+      term_id = (term.nil? ? Osm::Term.get_current_term_for_section(api, section, options) : term).to_i
+      cache_key = ['badge-summary', section.id, term_id, type]
+
+      if !options[:no_cache] && Osm::Model.cache_exist?(api, cache_key)
+        return cache_read(api, cache_key)
+      end
+
+      summary = []
+      data = api.perform_query("challenges.php?action=summary&section=#{section.type}&sectionid=#{section.id}&termid=#{term_id}&type=#{type}")
+      data['items'].each do |item|
+        new_item = {
+          :first_name => item['firstname'],
+          :last_name => item['lastname'],
+        }
+        (item.keys - ['firstname', 'lastname']).each do |key|
+          new_item[key] = item[key]
+        end
+        summary.push new_item
+      end
+
+      cache_write(api, cache_key, summary)
+      return summary
+    end
+
     # Get a list of badge requirements met by members
     # @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 due badges for
-    # @param [Osm::Badge] badge The badge to get data for
     # @param [Osm::Term, Fixnum, #to_i, nil] term The term (or its ID) to get the due badges for, passing nil causes the current term to be used
     # @!macro options_get
     # @return [Array<Osm::Badge::Data>]
-    def self.get_badge_data_for_section(api, section, badge, term=nil, options={})
-      raise Error, 'This method must be called on one of the subclasses (CoreBadge, ChallengeBadge, StagedBadge or ActivityBadge)' if badge_type.nil?
+    def get_data_for_section(api, section, term=nil, options={})
+      raise Error, 'This method must be called on one of the subclasses (CoreBadge, ChallengeBadge, StagedBadge or ActivityBadge)' if type.nil?
       Osm::Model.require_ability_to(api, :read, :badge, section, options)
       section = Osm::Section.get(api, section, options) unless section.is_a?(Osm::Section)
       term_id = (term.nil? ? Osm::Term.get_current_term_for_section(api, section, options) : term).to_i
-      cache_key = ['badge_data', section.id, term_id, badge.osm_key]
+      cache_key = ['badge_data', section.id, term_id, osm_key]
 
       if !options[:no_cache] && cache_exist?(api, cache_key)
         return cache_read(api, cache_key)
       end
 
       datas = []
-      data = api.perform_query("challenges.php?termid=#{term_id}&type=#{badge_type}&section=#{section.type}&c=#{badge.osm_key}&sectionid=#{section.id}")
+      data = api.perform_query("challenges.php?termid=#{term_id}&type=#{type}&section=#{section.type}&c=#{osm_key}&sectionid=#{section.id}")
       data['items'].each do |d|
         datas.push Osm::Badge::Data.new(
           :member_id => d['scoutid'],
-          :completed => d['completed'].eql?('1'),
+          :first_name => d['firstname'],
+          :last_name => d['lastname'],
+          :completed => d['completed'].to_i,
+          :awarded => d['awarded'].to_i,
           :awarded_date => Osm.parse_date(d['awardeddate']),
           :requirements => d.select{ |k,v| k.include?('_') },
           :section_id => section.id,
-          :badge => badge,
+          :badge => self,
         )
       end
 
@@ -140,13 +178,20 @@ module Osm
     end
 
 
-    private
-    def self.badge_type
+    def self.type
       nil
     end
+    def type
+      self.class.type
+    end
+
+    private
     def self.subscription_required
       :bronze
     end
+    def subscription_required
+      self.class.subscription_required
+    end
 
 
     class Requirement
@@ -196,14 +241,17 @@ module Osm
     end # Class Requirement
 
 
-    class Data
-      include ::ActiveAttr::MassAssignmentSecurity
-      include ::ActiveAttr::Model
-
+    class Data < Osm::Model
       # @!attribute [rw] member_id
       #   @return [Fixnum] ID of the member this data relates to
+      # @!attribute [rw] first_name
+      #   @return [Fixnum] the member's first name
+      # @!attribute [rw] last_name
+      #   @return [Fixnum] Ithe member's last name
       # @!attribute [rw] completed
-      #   @return [Boolean] whether this badge has been completed (i.e. it is due?)
+      #   @return [Fixnum] whether this badge has been completed (i.e. it is due?), number indicates stage if appropriate
+      # @!attribute [rw] awarded
+      #   @return [Date] the last stage awarded
       # @!attribute [rw] awarded_date
       #   @return [Date] when the badge was awarded
       # @!attribute [rw] requirements
@@ -214,16 +262,22 @@ module Osm
       #   @return [Osm::Badge] the badge that the data belongs to
 
       attribute :member_id, :type => Integer
-      attribute :completed, :type => Boolean
-      attribute :awarded_date, :type => Date
+      attribute :first_name, :type => String
+      attribute :last_name, :type => String
+      attribute :completed, :type => Integer, :default => 0
+      attribute :awarded, :type => Integer, :default => 0
+      attribute :awarded_date, :type => Date, :default => nil
       attribute :requirements, :type => Object, :default => DirtyHashy.new
       attribute :section_id, :type => Integer
       attribute :badge, :type => Object
 
-      attr_accessible :member_id, :completed, :awarded_date, :requirements, :section_id, :badge
+      attr_accessible :member_id, :first_name, :last_name, :completed, :awarded, :awarded_date, :requirements, :section_id, :badge
 
       validates_presence_of :badge
-      validates_inclusion_of :completed, :in => [true, false]
+      validates_presence_of :first_name
+      validates_presence_of :last_name
+      validates_numericality_of :completed, :only_integer=>true, :greater_than_or_equal_to=>0
+      validates_numericality_of :awarded, :only_integer=>true, :greater_than_or_equal_to=>0
       validates_numericality_of :member_id, :only_integer=>true, :greater_than=>0
       validates_numericality_of :section_id, :only_integer=>true, :greater_than=>0
       validates :requirements, :hash => {:key_type => String, :value_type => String}
@@ -246,7 +300,7 @@ module Osm
       def total_gained
         count = 0
         requirements.each do |field, data|
-          next if data.blank? || data.downcase[0].eql?('x')
+          next if data.blank? || data[0].downcase.eql?('x')
           count += 1
         end
         return count
@@ -273,12 +327,110 @@ module Osm
         requirements.each do |field, data|
           field = field.split('_')[0]
           count[field] ||= 0
-          next if data.blank? || data.downcase[0].eql?('x')
+          next if data.blank? || data[0].downcase.eql?('x')
           count[field] += 1
         end
         return count
       end
 
+      # Check if this badge is due
+      # @return [Boolean] whether the badge is due to the member
+      def due?
+        completed > awarded
+      end
+
+      # Check if this badge has been started
+      # @return [Boolean] whether the badge has been started by the member (always false if the badge has been completed)
+      def started?
+        unless badge.type == :staged
+          return false if completed?
+          requirements.each do |key, value|
+            return true unless value.blank? || value[0].downcase.eql?('x')
+          end
+        else
+          # Staged badge
+          return (started > completed)
+        end
+        return false
+      end
+
+      # Get which stage has been started
+      # @return [Fixnum] which stage of the badge has been started by the member (lowest)
+      def started
+        unless badge.type == :staged
+          return started? ? 1 : 0
+        else
+          # Staged badge
+          if ['nightsaway', 'hikes'].include?(badge.osm_key) # Special staged badges
+            stages = [1, 5, 10, 20, 35, 50, 75, 100, 125, 150, 175, 200] if badge.osm_key.eql?('nightsaway')
+            stages = [1, 5, 10, 20, 35, 50] if badge.osm_key.eql?('hikes')
+            done = requirements['y_01'].to_i
+            return 0 if done < stages[0]                # Not started the first stage
+            return 0 if done >= stages[stages.size - 1] # No more stages can be started
+            (1..stages.size-1).reverse_each do |index|
+              if (done < stages[index]) && (done > stages[index-1])
+                return stages[index]
+              end
+            end
+          else
+            start_group = 'abcde'[completed] # Requirements use the group letter to denote stage
+            started = 'z'
+            requirements.each do |key, value|
+              next if key[0] < start_group # This stage is marked as completed
+              next if key[0] > started     # This stage is after the stage currently started
+              started = key[0] unless value.blank? || value[0].downcase.eql?('x')
+            end
+            return started.eql?('z') ? 0 : 'abcde'.index(started)+1
+          end
+          return 0
+        end
+      end
+
+      # Mark the badge as awarded in OSM
+      # @param [Osm::Api] api The api to use to make the request
+      # @param [Date] date The date to mark the badge as awarded
+      # @param [Fixnum] level The level of the badge to award (1 for non-staged badges)
+      # @param [Symbol] mark_as :awarded or :due
+      # @return [Boolean] whether the data was updated in OSM
+      def mark_awarded(api, date=Date.today, level=completed, mark_as=:awarded)
+        raise ArgumentError, 'date is not a Date' unless date.is_a?(Date)
+        raise ArgumentError, 'mark_as is not an allowed value, use :awarded or :du' unless [:awarded, :due].include?(mark_as)
+        raise ArgumentError, 'level can not be negative' if level < 0
+        section = Osm::Section.get(api, section_id)
+        require_ability_to(api, :write, :badge, section)
+
+        date_formatted = date.strftime(Osm::OSM_DATE_FORMAT)
+
+        result = api.perform_query("challenges.php?action=award", {
+          'dateAwarded' => date_formatted,
+          'sectionid' => section_id,
+          'section' => section.type,
+          'chal' => badge.osm_key,
+          'type' => badge.type,
+          'stagedLevel' => level,
+          'due' => mark_as,
+        })
+        updated = result.is_a?(Array) &&
+                  result[0].is_a?(Hash) &&
+                  (result[0]['sid'].to_i == member_id) &&
+                  (result[0]['awarded'].to_i == level) &&
+                  (result[0]['awardeddate'] == date_formatted)
+
+        if updated
+          awarded = level
+          awarded_date = date
+        end
+        return updated
+      end
+
+      # Mark the badge as due in OSM
+      # @param [Osm::Api] api The api to use to make the request
+      # @param [Fixnum] level The level of the badge to mark as due (1 for non-staged badges)
+      # @return [Boolean] whether the data was updated in OSM
+      def mark_due(api, level)
+        mark_awarded(api, Date.today, level, :due)
+      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
@@ -286,13 +438,13 @@ module Osm
       def update(api)
         raise Osm::ObjectIsInvalid, 'data is invalid' unless valid?
         section = Osm::Section.get(api, section_id)
-        Osm::Model.require_ability_to(api, :write, :badge, section)
+        require_ability_to(api, :write, :badge, section)
 
         updated = true
         editable_fields = badge.requirements.select{ |r| r.editable }.map{ |r| r.field}
         requirements.changes.each do |field, (was,now)|
           if editable_fields.include?(field)
-            result = api.perform_query("challenges.php?type=#{badge.class.badge_type}&section=#{section.type}", {
+            result = api.perform_query("challenges.php?type=#{badge.class.type}&section=#{section.type}", {
               'action' => 'updatesingle',
               'id' => member_id,
               'col' => field,
@@ -306,11 +458,18 @@ module Osm
           end
         end
 
-
         if updated
           requirements.clean_up!
         end
 
+        if changed_attributes.include?('awarded') || changed_attributes.include?('awarded_date')
+          if mark_awarded(api, awarded_date, awarded)
+            reset_changed_attributes
+          else
+            updated = false
+          end
+        end
+
         return updated
       end
 
@@ -333,28 +492,28 @@ module Osm
 
   class CoreBadge < Osm::Badge
     private
-    def self.badge_type
+    def self.type
       :core
     end
   end # Class CoreBadge
 
   class ChallengeBadge < Osm::Badge
     private
-    def self.badge_type
+    def self.type
       :challenge
     end
   end # Class ChallengeBadge
 
   class StagedBadge < Osm::Badge
     private
-    def self.badge_type
+    def self.type
       :staged
     end
   end # Class StagedBadge
 
   class ActivityBadge < Osm::Badge
     private
-    def self.badge_type
+    def self.type
       :activity
     end
     def self.subscription_required

data/lib/osm/register.rb

@@ -56,7 +56,9 @@ module Osm
       end
 
       data = api.perform_query("users.php?action=register&sectionid=#{section_id}&termid=#{term_id}")
-      dates = get_structure(api, section, term, options).map{ |f| f.id }.select{ |f| f.match(Osm::OSM_DATE_REGEX) }
+      dates_s = get_structure(api, section, term, options)
+      dates_s = dates_s.map{ |f| f.id }.select{ |f| f.match(Osm::OSM_DATE_REGEX) }
+      dates_d = dates_s.map{ |d| Osm::parse_date(d) }
 
       to_return = []
       if data.is_a?(Hash) && data['items'].is_a?(Array)
@@ -65,9 +67,8 @@ module Osm
           if item.is_a?(Hash)
             unless item['scoutid'].to_i < 0  # It's a total row
               attendance = {}
-              dates.each do |date|
-                item_attendance = item[date]
-                date = Date.strptime(date, Osm::OSM_DATE_FORMAT)
+              dates_d.each_with_index do |date, index|
+                item_attendance = item[dates_s[index]]
                 attendance[date] = :unadvised_absent
                 attendance[date] = :yes if item_attendance.eql?('Yes')
                 attendance[date] = :advised_absent if item_attendance.eql?('No')

data/spec/osm/badge_spec.rb

@@ -44,7 +44,10 @@ describe "Badge" do
   it "Create Data" do
     data = Osm::Badge::Data.new(
       :member_id => 1,
-      :completed => true,
+      :first_name => 'First',
+      :last_name => 'Last',
+      :completed => 4,
+      :awarded => 3,
       :awarded_date => Date.new(2000, 1, 2),
       :requirements => {},
       :section_id => 2,
@@ -52,7 +55,10 @@ describe "Badge" do
     )
 
     data.member_id.should == 1
-    data.completed.should == true
+    data.first_name.should == 'First'
+    data.last_name.should == 'Last'
+    data.completed.should == 4
+    data.awarded.should == 3
     data.awarded_date.should == Date.new(2000, 1, 2)
     data.requirements.should == {}
     data.section_id.should == 2
@@ -128,6 +134,64 @@ describe "Badge" do
     data.sections_gained.should == 1
   end
 
+  it "Works out if the badge is due" do
+    Osm::Badge::Data.new(:completed => 0, :awarded => 0).due?.should be_false
+    Osm::Badge::Data.new(:completed => 1, :awarded => 0).due?.should be_true
+    Osm::Badge::Data.new(:completed => 2, :awarded => 2).due?.should be_false
+    Osm::Badge::Data.new(:completed => 2, :awarded => 1).due?.should be_true
+  end
+
+  it "Works out if the badge has been started" do
+    Osm::Badge::Data.new(:badge => Osm::CoreBadge.new, :requirements => {'a_01' => 'Yes', 'a_02' => ''}).started?.should be_true
+    Osm::Badge::Data.new(:badge => Osm::CoreBadge.new, :requirements => {'a_01' => 'Yes', 'a_02' => ''}, :completed => 1).started?.should be_false
+    Osm::Badge::Data.new(:badge => Osm::CoreBadge.new, :requirements => {'a_01' => 'xNo', 'a_02' => ''}).started?.should be_false
+    Osm::Badge::Data.new(:badge => Osm::CoreBadge.new, :requirements => {'a_01' => '', 'a_02' => ''}).started?.should be_false
+    # Staged Badge
+    Osm::Badge::Data.new(
+      :badge => Osm::StagedBadge.new,
+      :requirements => {'a_01' => 'Yes', 'b_01' => 'Yes', 'b_02' => ''},
+      :completed => 1,
+    ).started?.should be_true
+    Osm::Badge::Data.new(
+      :badge => Osm::StagedBadge.new(:osm_key => 'nightsaway'),
+      :requirements => {'a_01' => 5, 'y_01' => '5', 'custom_26695' => ''},
+      :completed => 5,
+    ).started?.should be_false
+    Osm::Badge::Data.new(
+      :badge => Osm::StagedBadge.new(:osm_key => 'hikes'),
+      :requirements => {'a_01' => 2, 'y_01' => '2', 'custom_26695' => ''},
+      :completed => 1,
+    ).started?.should be_true
+  end
+
+  it "Works out what stage of the badge has been started" do
+    Osm::Badge::Data.new(:badge => Osm::CoreBadge.new, :requirements => {'a_01' => 'Yes', 'a_02' => ''}).started.should == 1
+    Osm::Badge::Data.new(:badge => Osm::CoreBadge.new, :requirements => {'a_01' => 'Yes', 'a_02' => ''}, :completed => 1).started.should == 0
+    Osm::Badge::Data.new(:badge => Osm::CoreBadge.new, :requirements => {'a_01' => 'xNo', 'a_02' => ''}).started.should == 0
+    Osm::Badge::Data.new(:badge => Osm::CoreBadge.new, :requirements => {'a_01' => '', 'a_02' => ''}).started.should == 0
+
+    # Staged Badge
+    Osm::Badge::Data.new(
+      :badge => Osm::StagedBadge.new(:osm_key => 'test'),
+      :requirements => {'a_01' => 'Yes', 'b_01' => 'Yes', 'b_02' => ''},
+      :completed => 1,
+    ).started.should == 2
+    Osm::Badge::Data.new(
+      :badge => Osm::StagedBadge.new(:osm_key => 'test'),
+      :requirements => {'a_01' => 'Yes', 'b_01' => 'Yes', 'b_02' => '', 'c_01' => 'Yes', 'c_02' => ''},
+      :completed => 1,
+    ).started.should == 2
+    Osm::Badge::Data.new(
+      :badge => Osm::StagedBadge.new(:osm_key => 'nightsaway'),
+      :requirements => {'a_01' => 7, 'y_01' => '7', 'custom_26695' => ''},
+      :completed => 5,
+    ).started.should == 10
+    Osm::Badge::Data.new(
+      :badge => Osm::StagedBadge.new(:osm_key => 'hikes'),
+      :requirements => {'a_01' => 2, 'y_01' => '2', 'custom_26695' => ''},
+      :completed => 1,
+    ).started.should == 5
+  end
 
   describe "Using the OSM API" do
 
@@ -261,6 +325,14 @@ describe "Badge" do
         requirement.badge.osm_key.should == 'badge'
       end
 
+      it "For a different section type" do
+        FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/challenges.php?action=getInitialBadges&type=activity&sectionid=1&section=cubs&termid=2", :body => @data)
+        Osm::Term.stub(:get_current_term_for_section){ Osm::Term.new(:id => 2) }
+
+        badges = Osm::ActivityBadge.get_badges_for_section(@api, Osm::Section.new(:id => 1, :type => :beavers), :cubs)
+        badges.size.should == 1
+      end
+
     end
 
 
@@ -274,8 +346,8 @@ describe "Badge" do
             'firstname' => 'fn',
             'lastname' => 'ln',
             'sid' => '',
-            'completed' => '1',
-            'awarded' => '',
+            'completed' => '2',
+            'awarded' => '1',
             'awardeddate' => '2000-01-02',
             'patrolid' => 4,
             'a_1' => 'd',
@@ -286,11 +358,14 @@ describe "Badge" do
 
       it "Core badge" do
         FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/challenges.php?termid=2&type=core&section=beavers&c=badge&sectionid=1", :body => @data)
-        datas = Osm::CoreBadge.get_badge_data_for_section(@api, Osm::Section.new(:id => 1, :type => :beavers), Osm::Badge.new(:osm_key => 'badge'), 2)
+        datas = Osm::CoreBadge.new(:osm_key => 'badge').get_data_for_section(@api, Osm::Section.new(:id => 1, :type => :beavers), 2)
         datas.size.should == 1
         data = datas[0]
         data.member_id.should == 3
-        data.completed.should == true
+        data.first_name.should == 'fn'
+        data.last_name.should == 'ln'
+        data.completed.should == 2
+        data.awarded.should == 1
         data.awarded_date.should == Date.new(2000, 1, 2)
         data.requirements.should == {'a_1' => 'd'}
         data.section_id.should == 1
@@ -299,11 +374,14 @@ describe "Badge" do
 
       it "Challenge badge" do
         FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/challenges.php?termid=2&type=challenge&section=beavers&c=badge&sectionid=1", :body => @data)
-        datas = Osm::ChallengeBadge.get_badge_data_for_section(@api, Osm::Section.new(:id => 1, :type => :beavers), Osm::Badge.new(:osm_key => 'badge'), 2)
+        datas = Osm::ChallengeBadge.new(:osm_key => 'badge').get_data_for_section(@api, Osm::Section.new(:id => 1, :type => :beavers), 2)
         datas.size.should == 1
         data = datas[0]
         data.member_id.should == 3
-        data.completed.should == true
+        data.first_name.should == 'fn'
+        data.last_name.should == 'ln'
+        data.completed.should == 2
+        data.awarded.should == 1
         data.awarded_date.should == Date.new(2000, 1, 2)
         data.requirements.should == {'a_1' => 'd'}
         data.section_id.should == 1
@@ -312,11 +390,14 @@ describe "Badge" do
 
       it "Staged badge" do
         FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/challenges.php?termid=2&type=staged&section=beavers&c=badge&sectionid=1", :body => @data)
-        datas = Osm::StagedBadge.get_badge_data_for_section(@api, Osm::Section.new(:id => 1, :type => :beavers), Osm::Badge.new(:osm_key => 'badge'), 2)
+        datas = Osm::StagedBadge.new(:osm_key => 'badge').get_data_for_section(@api, Osm::Section.new(:id => 1, :type => :beavers), 2)
         datas.size.should == 1
         data = datas[0]
         data.member_id.should == 3
-        data.completed.should == true
+        data.first_name.should == 'fn'
+        data.last_name.should == 'ln'
+        data.completed.should == 2
+        data.awarded.should == 1
         data.awarded_date.should == Date.new(2000, 1, 2)
         data.requirements.should == {'a_1' => 'd'}
         data.section_id.should == 1
@@ -325,11 +406,14 @@ describe "Badge" do
 
       it "Activity badge" do
         FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/challenges.php?termid=2&type=activity&section=beavers&c=badge&sectionid=1", :body => @data)
-        datas = Osm::ActivityBadge.get_badge_data_for_section(@api, Osm::Section.new(:id => 1, :type => :beavers), Osm::Badge.new(:osm_key => 'badge'), 2)
+        datas = Osm::ActivityBadge.new(:osm_key => 'badge').get_data_for_section(@api, Osm::Section.new(:id => 1, :type => :beavers), 2)
         datas.size.should == 1
         data = datas[0]
         data.member_id.should == 3
-        data.completed.should == true
+        data.first_name.should == 'fn'
+        data.last_name.should == 'ln'
+        data.completed.should == 2
+        data.awarded.should == 1
         data.awarded_date.should == Date.new(2000, 1, 2)
         data.requirements.should == {'a_1' => 'd'}
         data.section_id.should == 1
@@ -341,7 +425,7 @@ describe "Badge" do
     describe "Update badge data for a section/member" do
 
       before :each do
-        @post_data = {
+        @update_post_data = {
           'apiid' => @CONFIGURATION[:api][:osm][:id],
           'token' => @CONFIGURATION[:api][:osm][:token],
           'userid' => 'user_id',
@@ -353,13 +437,29 @@ describe "Badge" do
           'chal' => 'badge',
           'sectionid' => 2,
         }
+        @update_body_data = {'sid' => '1', 'a' => '2', 'b' => '2'}
 
-        @body_data = {'sid' => '1', 'a' => '2', 'b' => '2'}
+        @awarded_post_data = {
+          'apiid' => @CONFIGURATION[:api][:osm][:id],
+          'token' => @CONFIGURATION[:api][:osm][:token],
+          'userid' => 'user_id',
+          'secret' => 'secret',
+          'dateAwarded' => '2000-01-02',
+          'sectionid' => 2,
+          'section' => :beavers,
+          'chal' => 'badge',
+          'stagedLevel' => 1,
+          'due' => :awarded,
+        }
+        @awarded_body_data = [{'sid'=>'1', 'awarded'=>'1', 'awardeddate'=>'2000-01-02'}]
+        @awarded_url = "https://www.onlinescoutmanager.co.uk/challenges.php?action=award"
       end
 
       it "Core badge" do
         data = Osm::Badge::Data.new(
           :member_id => 1,
+          :first_name => 'fn',
+          :last_name => 'ln',
           :section_id => 2,
           :requirements => {'a' => '1', 'b' => '2'},
           :badge => Osm::CoreBadge.new(
@@ -368,20 +468,25 @@ describe "Badge" do
               Osm::Badge::Requirement.new(:field => 'a', :editable => true),
               Osm::Badge::Requirement.new(:field => 'b', :editable => true),
             ]),
-          :completed => false,
+          :completed => 0,
         )
 
-        url = "https://www.onlinescoutmanager.co.uk/challenges.php?type=core&section=beavers"
-        HTTParty.should_receive(:post).with(url, {:body => @post_data}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>@body_data.to_json}) }
+        update_url = "https://www.onlinescoutmanager.co.uk/challenges.php?type=core&section=beavers"
+        HTTParty.should_receive(:post).with(update_url, {:body => @update_post_data}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>@update_body_data.to_json}) }
+        HTTParty.should_receive(:post).with(@awarded_url, {:body => @awarded_post_data.merge({'type' => :core})}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>@awarded_body_data.to_json}) }
         Osm::Section.stub(:get) { Osm::Section.new(:id => 2, :type => :beavers) }
 
         data.requirements['a'] = '2'
+        data.awarded = 1
+        data.awarded_date = Date.new(2000, 1, 2)
         data.update(@api).should be_true
       end
 
       it "Challenge badge" do
         data = Osm::Badge::Data.new(
           :member_id => 1,
+          :first_name => 'fn',
+          :last_name => 'ln',
           :section_id => 2,
           :requirements => {'a' => '1', 'b' => '2'},
           :badge => Osm::ChallengeBadge.new(
@@ -390,20 +495,25 @@ describe "Badge" do
               Osm::Badge::Requirement.new(:field => 'a', :editable => true),
               Osm::Badge::Requirement.new(:field => 'b', :editable => true),
             ]),
-          :completed => false,
+          :completed => 0,
         )
 
-        url = "https://www.onlinescoutmanager.co.uk/challenges.php?type=challenge&section=beavers"
-        HTTParty.should_receive(:post).with(url, {:body => @post_data}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>@body_data.to_json}) }
+        update_url = "https://www.onlinescoutmanager.co.uk/challenges.php?type=challenge&section=beavers"
+        HTTParty.should_receive(:post).with(update_url, {:body => @update_post_data}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>@update_body_data.to_json}) }
+        HTTParty.should_receive(:post).with(@awarded_url, {:body => @awarded_post_data.merge({'type' => :challenge})}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>@awarded_body_data.to_json}) }
         Osm::Section.stub(:get) { Osm::Section.new(:id => 2, :type => :beavers) }
 
         data.requirements['a'] = '2'
+        data.awarded = 1
+        data.awarded_date = Date.new(2000, 1, 2)
         data.update(@api).should be_true
       end
 
       it "Staged badge" do
         data = Osm::Badge::Data.new(
           :member_id => 1,
+          :first_name => 'fn',
+          :last_name => 'ln',
           :section_id => 2,
           :requirements => {'a' => '1', 'b' => '2'},
           :badge => Osm::StagedBadge.new(
@@ -412,20 +522,25 @@ describe "Badge" do
               Osm::Badge::Requirement.new(:field => 'a', :editable => true),
               Osm::Badge::Requirement.new(:field => 'b', :editable => true),
             ]),
-          :completed => false,
+          :completed => 0,
         )
 
-        url = "https://www.onlinescoutmanager.co.uk/challenges.php?type=staged&section=beavers"
-        HTTParty.should_receive(:post).with(url, {:body => @post_data}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>@body_data.to_json}) }
+        update_url = "https://www.onlinescoutmanager.co.uk/challenges.php?type=staged&section=beavers"
+        HTTParty.should_receive(:post).with(update_url, {:body => @update_post_data}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>@update_body_data.to_json}) }
+        HTTParty.should_receive(:post).with(@awarded_url, {:body => @awarded_post_data.merge({'type' => :staged})}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>@awarded_body_data.to_json}) }
         Osm::Section.stub(:get) { Osm::Section.new(:id => 2, :type => :beavers) }
 
         data.requirements['a'] = '2'
+        data.awarded = 1
+        data.awarded_date = Date.new(2000, 1, 2)
         data.update(@api).should be_true
       end
 
       it "Activity badge" do
         data = Osm::Badge::Data.new(
           :member_id => 1,
+          :first_name => 'fn',
+          :last_name => 'ln',
           :section_id => 2,
           :requirements => {'a' => '1', 'b' => '2'},
           :badge => Osm::ActivityBadge.new(
@@ -434,19 +549,171 @@ describe "Badge" do
               Osm::Badge::Requirement.new(:field => 'a', :editable => true),
               Osm::Badge::Requirement.new(:field => 'b', :editable => true),
             ]),
-          :completed => false,
+          :completed => 0,
         )
 
-        url = "https://www.onlinescoutmanager.co.uk/challenges.php?type=activity&section=beavers"
-        HTTParty.should_receive(:post).with(url, {:body => @post_data}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>@body_data.to_json}) }
+        update_url = "https://www.onlinescoutmanager.co.uk/challenges.php?type=activity&section=beavers"
+        HTTParty.should_receive(:post).with(update_url, {:body => @update_post_data}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>@update_body_data.to_json}) }
+        HTTParty.should_receive(:post).with(@awarded_url, {:body => @awarded_post_data.merge({'type' => :activity})}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>@awarded_body_data.to_json}) }
         Osm::Section.stub(:get) { Osm::Section.new(:id => 2, :type => :beavers) }
 
         data.requirements['a'] = '2'
+        data.awarded = 1
+        data.awarded_date = Date.new(2000, 1, 2)
         data.update(@api).should be_true
       end
 
     end
 
+
+    describe "Mark badge awarded" do
+
+      before :each do
+        @awarded_post_data = {
+          'apiid' => @CONFIGURATION[:api][:osm][:id],
+          'token' => @CONFIGURATION[:api][:osm][:token],
+          'userid' => 'user_id',
+          'secret' => 'secret',
+          'dateAwarded' => '2000-01-02',
+          'sectionid' => 2,
+          'section' => :beavers,
+          'chal' => 'badge',
+          'stagedLevel' => 1,
+          'due' => :awarded,
+        }
+        @awarded_body_data = [{'sid'=>'1', 'awarded'=>'1', 'awardeddate'=>'2000-01-02'}]
+        @awarded_url = "https://www.onlinescoutmanager.co.uk/challenges.php?action=award"
+      end
+
+      it "Core badge" do
+        data = Osm::Badge::Data.new(
+          :member_id => 1,
+          :section_id => 2,
+          :badge => Osm::CoreBadge.new(
+            :osm_key => 'badge',
+          )
+        )
+
+        HTTParty.should_receive(:post).with(@awarded_url, {:body => @awarded_post_data.merge({'type' => :core})}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>@awarded_body_data.to_json}) }
+        Osm::Section.stub(:get) { Osm::Section.new(:id => 2, :type => :beavers) }
+
+        data.mark_awarded(@api, Date.new(2000, 1, 2), 1).should be_true
+      end
+
+      it "Challenge badge" do
+        data = Osm::Badge::Data.new(
+          :member_id => 1,
+          :section_id => 2,
+          :badge => Osm::ChallengeBadge.new(
+            :osm_key => 'badge',
+          )
+        )
+
+        HTTParty.should_receive(:post).with(@awarded_url, {:body => @awarded_post_data.merge({'type' => :challenge})}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>@awarded_body_data.to_json}) }
+        Osm::Section.stub(:get) { Osm::Section.new(:id => 2, :type => :beavers) }
+
+        data.mark_awarded(@api, Date.new(2000, 1, 2), 1).should be_true
+      end
+
+      it "Staged badge" do
+        data = Osm::Badge::Data.new(
+          :member_id => 1,
+          :section_id => 2,
+          :badge => Osm::StagedBadge.new(
+            :osm_key => 'badge',
+          )
+        )
+
+        @awarded_body_data[0].merge!({'awarded' => '4'})
+        HTTParty.should_receive(:post).with(@awarded_url, {:body => @awarded_post_data.merge({'type' => :staged, 'stagedLevel' => 4})}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>@awarded_body_data.to_json}) }
+        Osm::Section.stub(:get) { Osm::Section.new(:id => 2, :type => :beavers) }
+
+        data.mark_awarded(@api, Date.new(2000, 1, 2), 4).should be_true
+      end
+
+      it "Activity badge" do
+        data = Osm::Badge::Data.new(
+          :member_id => 1,
+          :section_id => 2,
+          :badge => Osm::ActivityBadge.new(
+            :osm_key => 'badge',
+          )
+        )
+
+        HTTParty.should_receive(:post).with(@awarded_url, {:body => @awarded_post_data.merge({'type' => :activity})}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>@awarded_body_data.to_json}) }
+        Osm::Section.stub(:get) { Osm::Section.new(:id => 2, :type => :beavers) }
+
+        data.mark_awarded(@api, Date.new(2000, 1, 2), 1).should be_true
+      end
+
+    end
+
+
+    describe "Get summary data for a section" do
+
+      before :each do
+        @data = {
+          'items' => [
+            {
+              'firstname' => 'First',
+              'lastname' => 'Last',
+              'badge_none' => '',
+              'badge_earnt' => '2000-01-02',
+            }
+          ]
+        }
+        @data = @data.to_json
+      end
+
+      it "Core badge" do
+        FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/challenges.php?action=summary&section=beavers&sectionid=1&termid=2&type=core", :body => @data)
+        summary = Osm::CoreBadge.get_summary_for_section(@api, Osm::Section.new(:id => 1, :type => :beavers), 2)
+        summary.size.should == 1
+        summary[0].should == {
+          :first_name => 'First',
+          :last_name => 'Last',
+          'badge_none' => '',
+          'badge_earnt' => '2000-01-02',
+        }
+      end
+
+      it "Challenge badge" do
+        FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/challenges.php?action=summary&section=beavers&sectionid=1&termid=2&type=challenge", :body => @data)
+        summary = Osm::ChallengeBadge.get_summary_for_section(@api, Osm::Section.new(:id => 1, :type => :beavers), 2)
+        summary.size.should == 1
+        summary[0].should == {
+          :first_name => 'First',
+          :last_name => 'Last',
+          'badge_none' => '',
+          'badge_earnt' => '2000-01-02',
+        }
+      end
+
+      it "Staged badge" do
+        FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/challenges.php?action=summary&section=beavers&sectionid=1&termid=2&type=staged", :body => @data)
+        summary = Osm::StagedBadge.get_summary_for_section(@api, Osm::Section.new(:id => 1, :type => :beavers), 2)
+        summary.size.should == 1
+        summary[0].should == {
+          :first_name => 'First',
+          :last_name => 'Last',
+          'badge_none' => '',
+          'badge_earnt' => '2000-01-02',
+        }
+      end
+
+      it "Activity badge" do
+        FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/challenges.php?action=summary&section=beavers&sectionid=1&termid=2&type=activity", :body => @data)
+        summary = Osm::ActivityBadge.get_summary_for_section(@api, Osm::Section.new(:id => 1, :type => :beavers), 2)
+        summary.size.should == 1
+        summary[0].should == {
+          :first_name => 'First',
+          :last_name => 'Last',
+          'badge_none' => '',
+          'badge_earnt' => '2000-01-02',
+        }
+      end
+    end
+
   end
 
 end

data/version.rb

@@ -1,3 +1,3 @@
 module Osm
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osm
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-29 00:00:00.000000000 Z
+date: 2013-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport