osm 1.2.15.dev → 1.2.15.dev.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTc4ZGUzMmFjNjdhZjNhY2M0MzdjNGJhODk4MGJhOTY1NjM2YmJlMA==
+    YjFmYjY4MTk2NDUyYzEyNDJhNGE1ZTVhOGZhZTBiOWZhOTUwYzM3Zg==
   data.tar.gz: !binary |-
-    ZmIyMGUyZDVlNzU5MmFkNjUwNTJiNGJiODJjZDc1MDZjZDJhMWMzYg==
+    ZmVjMjkwMDUwOWU3NzMzZGZiMmM3ZWI3MmFmYTVlMDA1ZjVlNTBkNw==
 SHA512:
   metadata.gz: !binary |-
-    ZDViMmI1NDdhZThkMDcxYzc4Nzk1ZDZiNjM5MDJiMThhNDA0ZWU3YjQyNjdk
-    YTJlYjYyZTU1ZDczMWJlMmY5Yjc3NmZhNWIzZjIwNDllZWIwM2Q3MDEwNzZj
-    ODg4NjI5YzFmOWI0N2NiOGQ1ODg0ZmRlYmJkMWI1ZDAwMGNkMzQ=
+    ZDI5NzA5NzMxY2FhYmFmZDYxMTAwY2Y0MTBkMTZkYjhkZjUzZTMzYjJjZTU0
+    N2RhOTU1OTViMTFiZGY5YzNjMjE4MWE0ZDFlMzIxZTUwNjE3OTI2YzBiYzll
+    ODZjMmY3MjdkNjIzZDA5MGNmMjQyNTVhMWNhMWZkOTM5ODJhZTg=
   data.tar.gz: !binary |-
-    ZWIxMTU3NmVmMmNkOWI2MTc0OGJjNjA3MGRiODY2YTZhMTExN2UyMTdkOWY0
-    ZWNjNTdhZDE5MGE3MTc1MzBhZDAxYWJlMjdiNTQ1MGZiMDZiZDNkMDRjOTVk
-    NmFmODIyMGExOWI5ZTg0NGQ1NTg4ZTE5NzMwNjYzMTY5ZWIyZjY=
+    ZTczZjNmMDc1M2E3ZGJkYTVmZDJhM2VjYmFhOGVhODk5Y2E0ZWQwM2FlZTYx
+    ZTM0MzJhMDZlY2VlZjM1ZmYwNzZkNjI1NzNjYmI0ZGRhZjQwZTlkNTUxODQ0
+    YjVlYTU5ZGE3NDg0MTU1NTE4MTAxY2I4YjI1ZDQzMGU0NWRjZmY=

data/CHANGELOG.md

@@ -16,6 +16,7 @@
       * id, version, identifier, group\_name, latest, user\_id, levels, sharing attributes added
       * OSM Changed how completion criteria are retrieved (this gem now uses a special peice of OSM's API just for this purpose) so:
         * Osm::Badge attributes sections\_needed, total\_needed and needed\_from\_section are gone
+      * New methods modules, module_letters and module_ids
     * Osm::Badge::Data
       * mark\_awarded method now only marks as awarded (the optional mark\_as parameter is gone)
       * mark\_not\_awarded method added
@@ -29,6 +30,8 @@
       * Attributes untouched: badge\_type, badge\_section, data, requirement\_label
     * Osm::Activity::Badge attributes now match Osm::Event::BadgeLink
     * Osm::Meeting::BadgeLink attributes now match Osm::Event::badgeLink
+    * Osm::Badges.get_badge_stock returns a Hash, keys are now "#{badge_id}_#{level}"
+    * Osm::Badge::Data instance method requirement_met?(field_id) method made public
 
 ## Version 1.2.14
 

data/lib/osm.rb

@@ -34,7 +34,8 @@ module Osm
   OSM_DATE_FORMAT_HUMAN = '%d/%m/%Y'
   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/
+  OSM_DATE_REGEX_UNANCHORED = /(?:[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}))/
+  OSM_DATE_REGEX = /\A#{Osm::OSM_DATE_REGEX_UNANCHORED.to_s}\Z/
   SUBSCRIPTION_LEVEL_NAMES = ['Unknown', 'Bronze', 'Silver', 'Gold', 'Gold+']
   SUBSCRIPTION_LEVELS = [nil, :bronze, :silver, :gold, :gold_plus]
 end

data/lib/osm/badge.rb

@@ -170,14 +170,29 @@ module Osm
         badge_data = Hash[item.to_a.select{ |k,v| !!k.match(/\d+_\d+/) }]
         badge_data.each do |badge_identifier, status|
           if status.is_a?(String)
-            # Possible statuses: 'Started', 'Due', 'Awarded', 'Due Lvl ?' & 'Awarded Lvl ?'
-            case status[0]
-              when 'S'
-                new_item[badge_identifier] = :started
-              when 'D'
-                new_item[badge_identifier] = :due
-              when 'A'
-                new_item[badge_identifier] = :awarded
+            # Possible statuses: 
+            # 'Started',
+            # 'Due', 'Due Lvl 2'
+            # 'Awarded', 'Awarded Lvl 2', '01/02/2003', '02/03/2004 (Lvl 2)'
+            if status.eql?('Started')
+              new_item[badge_identifier] = :started
+            elsif status.eql?('Due')
+              new_item[badge_identifier] = :due
+            elsif match_data = status.match(/\ADue Lvl (\d+)\Z/)
+              new_item[badge_identifier] = :due
+              new_item["#{badge_identifier}_level"] = match_data[1].to_i
+            elsif status.eql?('Awarded')
+              new_item[badge_identifier] = :awarded
+            elsif match_data = status.match(/\AAwarded Lvl (\d+)\Z/)
+              new_item[badge_identifier] = :awarded
+              new_item["#{badge_identifier}_level"] = match_data[1].to_i
+            elsif match_data = status.match(Osm::OSM_DATE_REGEX)
+              new_item[badge_identifier] = :awarded
+              new_item["#{badge_identifier}_date"] = Osm.parse_date(match_data[0])
+            elsif match_data = status.match(/\A(#{Osm::OSM_DATE_REGEX_UNANCHORED.to_s}) \(Lvl (\d+)\)\Z/)
+              new_item[badge_identifier] = :awarded
+              new_item["#{badge_identifier}_date"] = Osm.parse_date(match_data[1])
+              new_item["#{badge_identifier}_level"] = match_data[2].to_i
             end
           end
         end
@@ -246,6 +261,18 @@ module Osm
       }.flatten].except('z')
     end
 
+    def module_letters
+      @module_letters ||= completion_criteria[:modules].map{ |m| m[:module_letter] }.sort
+    end
+
+    def module_ids
+      @module_ids ||= completion_criteria[:modules].map{ |m| m[:module_id] }.sort
+    end
+
+    def modules
+      completion_criteria[:modules] || []
+    end
+
 
     # Compare Badge based on name then id then version (desc)
     def <=>(another)
@@ -443,8 +470,8 @@ module Osm
       # @return [Fixnum] the total number of requirements considered gained
       def total_gained
         count = 0
-        requirements.each do |field_id, data|
-          next unless requirement_met?(data)
+        badge.requirements.each do |requirement|
+          next unless requirement_met?(requirement.field)
           count += 1
         end
         return count
@@ -472,7 +499,7 @@ module Osm
         count = {}
         badge.requirements.each do |requirement|
           count[requirement.module_letter] ||= 0
-          next unless requirement_met?(requirements[requirement.field])
+          next unless requirement_met?(requirement.field)
           count[requirement.module_letter] += 1
         end
         Hash[*count.map{ |k,v| [badge.module_map[k], v, k, v] }.flatten]
@@ -549,7 +576,7 @@ module Osm
         end
         return false if due?
         requirements.each do |key, value|
-          return true if requirement_met?(value)
+          return true if requirement_met?(key)
         end
         return false
       end
@@ -581,7 +608,7 @@ module Osm
           ((due + 1)..top_level).reverse_each do |level|
             badge.requirements.each do |requirement|
               next unless requirement.module_letter.eql?(letters[level - 1]) # Not interested in other levels
-              return level if requirement_met?(requirements[requirement.field])
+              return level if requirement_met?(requirement.field)
             end
           end
           return 0 # No levels started
@@ -726,10 +753,13 @@ module Osm
         Osm.inspect_instance(self, options={:replace_with => {'badge' => :name}})
       end
 
-      private
-      def requirement_met?(data)
-        return false if data == 0
-        !(data.blank? || data.to_s[0].downcase.eql?('x'))
+      # Work out if the requirmeent has been met
+      # @param [Fixnum, #to_i] field_id The id of the field to evaluate (e.g. "12", "xSomething", "Yes" or "")
+      # @return [Boolean] whether the requirmeent has been met
+      def requirement_met?(field_id)
+        data = requirements[field_id.to_i].to_s
+        return false if data == '0'
+        !(data.blank? || data[0].downcase.eql?('x'))
       end
 
     end # Class Data

data/lib/osm/badges.rb

@@ -19,7 +19,7 @@ module Osm
 
       data = api.perform_query("ext/badges/stock/?action=getBadgeStock&section=#{section.type}&section_id=#{section.id}&term_id=#{term_id}")
       data = (data['items'] || [])
-      data.map!{ |i| [i['shortname'], i['stock']] }
+      data.map!{ |i| [i['badge_id_level'], i['stock']] }
       data = Hash[data]
 
       Osm::Model.cache_write(api, cache_key, data)

data/lib/osm/meeting.rb

@@ -283,12 +283,31 @@ module Osm
       else
         # We'll have to iterate through the activities
         require_ability_to(api, :read, :programme, section_id, options)
-        badges = badge_links
+
+        links = badge_links
         activities.each do |activity|
           activity = Osm::Activity.get(api, activity.activity_id, nil, options)
-          activity.badges.each do |badge|
-            badges.push badge
-          end
+          links += activity.badges
+        end
+
+        badges = []
+        links.each do |badge|
+          badges.push({
+            "badge" => nil,#"activity_animalcarer",
+            "badge_id" => badge.badge_id,
+            "badge_version" => badge.badge_version,
+            "column_id" => badge.requirement_id,
+            "badgeName" => badge.badge_name,
+            "badgetype" => badge.badge_type,
+            "columngroup" => nil,#"A",
+            "columnname" => nil,#"a",
+            "data" => badge.data,
+            "eveningid" => id,
+            "meetingdate" => date,
+            "name" => badge.requirement_label,
+            "section" => badge.badge_section,
+            "sectionid" => section_id
+          })
         end
       end
 

data/spec/osm/badge_spec.rb

@@ -64,6 +64,38 @@ describe "Badge" do
     requirement.valid?.should be_true
   end
 
+  it "Produces a map of module letter <-> module id" do
+    badge = Osm::Badge.new(completion_criteria:{ modules: [
+      {module_id: 2, module_letter: 'c'},
+      {module_id: 10, module_letter: 'b'},
+      {module_id: 1, module_letter: 'a'}
+    ]})
+
+    badge.module_map.should == {1=>'a', 10=>'b', 2=>'c', 'a'=>1, 'b'=>10, 'c'=>2}
+  end
+
+  it "Gets the number of requirements needed per module" do
+    badge = Osm::Badge.new(completion_criteria:{ modules: [
+      {module_id: 2, module_letter: 'c', min_required: 5},
+      {module_id: 10, module_letter: 'b', min_required: 4},
+      {module_id: 1, module_letter: 'a', min_required: 3}
+    ]})
+
+    badge.needed_per_module.should == {'a'=>3, 'b'=>4, 'c'=>5, 2=>5, 10=>4, 1=>3}
+  end
+
+  it "Produces a list of modules" do
+    badge = Osm::Badge.new(completion_criteria:{ modules: [
+      {module_id: 2, module_letter: 'c'},
+      {module_id: 10, module_letter: 'b'},
+      {module_id: 1, module_letter: 'a'}
+    ]})
+
+    badge.module_letters.should == ['a', 'b', 'c']
+    badge.module_ids.should == [1, 2, 10]
+  end
+
+
   it "Create Data" do
     data = Osm::Badge::Data.new(
       :member_id => 1,
@@ -117,18 +149,43 @@ describe "Badge" do
   end
 
 
+  it "Works out if a requirement has been met" do
+    data = Osm::Badge::Data.new(requirements: {1 => ''}).requirement_met?(1).should be_false
+    data = Osm::Badge::Data.new(requirements: {1 => 'xStuff'}).requirement_met?(1).should be_false
+    data = Osm::Badge::Data.new(requirements: {1 => '0'}).requirement_met?(1).should be_false
+    data = Osm::Badge::Data.new(requirements: {1 => 0}).requirement_met?(1).should be_false
+    data = Osm::Badge::Data.new(requirements: {}).requirement_met?(1).should be_false
+    data = Osm::Badge::Data.new(requirements: {1 => 'Stuff'}).requirement_met?(1).should be_true
+    data = Osm::Badge::Data.new(requirements: {1 => '1'}).requirement_met?(1).should be_true
+    data = Osm::Badge::Data.new(requirements: {1 => 1}).requirement_met?(1).should be_true
+  end
+
+
   it "Get total requirements gained for a member" do
     data = Osm::Badge::Data.new(
+      :badge => Osm::Badge.new(
+        :requirements => [
+          Osm::Badge::Requirement.new(field: 1),
+          Osm::Badge::Requirement.new(field: 2),
+          Osm::Badge::Requirement.new(field: 3),
+          Osm::Badge::Requirement.new(field: 4),
+          Osm::Badge::Requirement.new(field: 5),
+          Osm::Badge::Requirement.new(field: 6),
+          Osm::Badge::Requirement.new(field: 7),
+          Osm::Badge::Requirement.new(field: 8),
+          Osm::Badge::Requirement.new(field: 9),
+        ]
+      ),
       :requirements => {
-        'a_1' => 'a',
-        'a_2' => 'yes',
-        'a_3' => '2000-01-02',
-        'a_4' => 1,
-        'b_1' => 'x',
-        'b_2' => 'xYES',
-        'b_3' => '',
-        'b_4' => nil,
-        'b_5' => 0,
+        1 => 'a',
+        2 => 'yes',
+        3 => '2000-01-02',
+        4 => 1,
+        5 => 'x',
+        6 => 'xYES',
+        7 => '',
+        8 => nil,
+        9 => 0,
       }
     )
     data.total_gained.should == 4
@@ -789,13 +846,15 @@ describe "Badge" do
             'firstname' => 'First',
             'lastname' => 'Last',
             'scout_id' => 1,
-            '92_0' => nil,
-            '93_0' => '',
-            '94_0' => 'Started',
-            '95_0' => 'Due',
-            '96_0' => 'Awarded',
-            '97_0' => 'Awarded Lvl 2',
-            '98_0' => 'Due Lvl 3',
+            '90_0' => nil,
+            '91_0' => '',
+            '92_0' => 'Started',
+            '93_0' => 'Due',
+            '94_0' => 'Due Lvl 3',
+            '95_0' => 'Awarded',
+            '96_0' => 'Awarded Lvl 2',
+            '97_0' => '01/02/2003',
+            '98_0' => '02/03/2004 (Lvl 1)',
           }
         ]
       }
@@ -809,11 +868,18 @@ describe "Badge" do
         :last_name => 'Last',
         :name => 'First Last',
         :member_id => 1,
-        '94_0' => :started,
-        '95_0' => :due,
+        '92_0' => :started,
+        '93_0' => :due,
+        '94_0' => :due,
+        '94_0_level' => 3,
+        '95_0' => :awarded,
         '96_0' => :awarded,
+        '96_0_level' => 2,
         '97_0' => :awarded,
-        '98_0' => :due,
+        '97_0_date' => Date.new(2003, 2, 1),
+        '98_0' => :awarded,
+        '98_0_date' => Date.new(2004, 3, 2),
+        '98_0_level' => 1,
       }
     end
 

data/spec/osm/badges_spec.rb

@@ -109,15 +109,15 @@ describe "Badges" do
       badges_body = {
         'identifier' => 'badge_id_level',
         'items' => [
-          { 'shortname' => 'badge_1', 'stock' => 1, 'desired' => 0, 'due' => 0 },
-          { 'shortname' => 'badge_2', 'stock' => 2, 'desired' => 0, 'due' => 0 },
+          { 'shortname' => 'badge_1', 'stock' => 1, 'desired' => 0, 'due' => 0, 'badge_id_level' => '100_1' },
+          { 'shortname' => 'badge_2', 'stock' => 2, 'desired' => 0, 'due' => 0, 'badge_id_level' => '200_2' },
         ]
       }
       FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/ext/badges/stock/?action=getBadgeStock&section=beavers&section_id=1&term_id=2", :body => badges_body.to_json, :content_type => 'application/json')
       Osm::Term.stub(:get_current_term_for_section) { Osm::Term.new(:id => 2) }
 
       section = Osm::Section.new(:id => 1, :type => :beavers)
-      Osm::Badges.get_stock(@api, section).should == {'badge_1' => 1, 'badge_2' => 2}
+      Osm::Badges.get_stock(@api, section).should == {'100_1' => 1, '200_2' => 2}
     end
 
     describe "Update badge stock levels" do

data/spec/osm/meeting_spec.rb

@@ -155,74 +155,24 @@ describe "Meeting" do
       ]
       FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/api.php?action=getUserRoles", :body => roles_body.to_json, :content_type => 'application/json')
 
-      activity_body = {
-        'details' => {
-          'activityid' => '4',
-          'version' => '0',
-          'groupid' => '2',
-          'userid' => '3',
-          'title' => 'Activity Name',
-          'description' => 'Description',
-          'resources' => 'Resources',
-          'instructions' => 'Instructions',
-          'runningtime' => '15',
-          'location' => 'indoors',
-          'shared' => '0',
-          'rating' => '4',
-          'facebook' => ''
-        },
-        'editable' => true,
-        'deletable' => false,
-        'used' => 3,
-        'versions' => [
-          {
-            'value' => '0',
-            'userid' => '1',
-            'firstname' => 'Alice',
-            'label' => 'Current version - Alice',
-            'selected' => 'selected'
-          }
-        ],
-        'sections' => ['beavers', 'cubs'],
-        'tags' => ['Tag 1', 'Tag2'],
-        'files' => [
-          {
-            'fileid' => '6',
-            'activityid' => '4',
-            'filename' => 'File Name',
-            'name' => 'Name',
-          }
-        ],
-        'badges' => [
-          {
-            'badge' => 'activity_firesafety',
-            'badgeLongName' => 'Fire Safety',
-            'badge_id' => '181',
-            'badge_version' => '0',
-            'badgetype' => 'activity',
-            'badgetypeLongName' => 'Activity',
-            'column_id' => '12345',
-            'columnname' => 'b_01',
-            'columnnameLongName' => 'B: Fire drill',
-            'data' => 'Yes',
-            'section' => 'cubs',
-            'sectionLongName' => 'Cubs',
-          }
-        ]
-      }
-
-      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/programme.php?action=getActivity&id=4", :body => activity_body.to_json, :content_type => 'application/json')
-      Osm::Activity.stub(:get) { Osm::Activity.new(:badges => [3]) }
+      Osm::Activity.stub(:get) { Osm::Activity.new(:badges => [
+        Osm::Activity::Badge.new(badge_type: :activity, badge_section: :beavers, requirement_label: 'label', data: 'data', badge_name: 'badge', badge_id: 2, badge_version: 0, requirement_id: 200)
+      ]) }
   
       meeting = Osm::Meeting.new(
         :id => 2,
         :date => Date.new(2000, 1, 2),
         :section_id => 3,
         :activities => [Osm::Meeting::Activity.new(:activity_id => 4)],
-        :badge_links => [1, 2],
+        :badge_links => [
+          Osm::Activity::Badge.new(badge_type: :activity, badge_section: :beavers, requirement_label: 'label 2', data: 'data 2', badge_name: 'badge 2', badge_id: 4, badge_version: 1, requirement_id: 400)
+        ],
       )
 
-      meeting.get_badge_requirements(@api).should == [1, 2, 3]
+      meeting.get_badge_requirements(@api).should == [
+        {"badge"=>nil, "badge_id"=>4, "badge_version"=>1, "column_id"=>400, "badgeName"=>"badge 2", "badgetype"=>:activity, "columngroup"=>nil, "columnname"=>nil, "data"=>"data 2", "eveningid"=>2, "meetingdate"=>Date.new(2000, 1, 2), "name"=>"label 2", "section"=>:beavers, "sectionid"=>3},
+        {"badge"=>nil, "badge_id"=>2, "badge_version"=>0, "column_id"=>200, "badgeName"=>"badge", "badgetype"=>:activity, "columngroup"=>nil, "columnname"=>nil, "data"=>"data", "eveningid"=>2, "meetingdate"=>Date.new(2000, 1, 2), "name"=>"label", "section"=>:beavers, "sectionid"=>3}
+      ]
     end
 
     it "Create a meeting (succeded)" do

data/version.rb

@@ -1,3 +1,3 @@
 module Osm
-  VERSION = "1.2.15.dev"
+  VERSION = "1.2.15.dev.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osm
 version: !ruby/object:Gem::Version
-  version: 1.2.15.dev
+  version: 1.2.15.dev.1
 platform: ruby
 authors:
 - Robert Gauld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-20 00:00:00.000000000 Z
+date: 2014-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport