osm 0.1.15 → 0.1.16

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## Version 0.1.16
+
+  * Member's grouping attribute:
+    * Renamed to grouping\_label
+    * Virtual attribute grouping added (maps to grouping\_label currently) marked as depricated as it will use a Grouping object not a String in the future
+  * Fix exception when OSM returns empty string when requesting groupings for a section
+  * Fix exception when OSM returns empty string when requesting register structure for a section
+  * Fix updating of grouping for Member
+  * Fix validation error for Member - a leader's joining\_in\_years is -1
+  * Add spaces and spaces? methods to Event
+
 ## Version 0.1.15
 
   * Rename grouping\_name attribute of Member to grouping

data/lib/osm/event.rb

@@ -325,8 +325,32 @@ module Osm
       (attendance_limit != 0)
     end
 
+    # Whether there are spaces left for the event
+    # @param [Osm::Api] api The api to use to make the request
+    # @return [Boolean] whether there are spaces left for the event
+    def spaces?(api)
+      return true unless limited_attendance?
+      return attendance_limit > attendees(api)
+    end
+
+    # Get the number of spaces left for the event
+    # @param [Osm::Api] api The api to use to make the request
+    # @return [Fixnum, nil] the number of spaces left (nil if there is no attendance limit)
+    def spaces(api)
+      return nil unless limited_attendance?
+      return attendance_limit - attendees(api)
+    end
+
 
     private
+    def attendees(api)
+      attendees = 0
+      get_attendance(api).each do |a|
+        attendees += 1 unless attendance_limit_includes_leaders && (a.grouping_id == -2)
+      end
+      return attendees
+    end
+
     def self.new_event_from_data(event_data)
       event = Osm::Event.new(
         :id => Osm::to_i_or_nil(event_data['eventid']),

data/lib/osm/grouping.rb

@@ -44,16 +44,18 @@ module Osm
       data = api.perform_query("users.php?action=getPatrols&sectionid=#{section_id}")
 
       result = Array.new
-      data['patrols'].each do |item|
-        result.push Osm::Grouping.new({
-        :id => Osm::to_i_or_nil(item['patrolid']),
-        :section_id => section_id,
-        :name => item['name'],
-        :active => (item['active'] == 1),
-        :points => Osm::to_i_or_nil(item['points']),
-      })
+      if data.is_a?(Hash) && data['patrols'].is_a?(Array)
+        data['patrols'].each do |item|
+          result.push Osm::Grouping.new({
+          :id => Osm::to_i_or_nil(item['patrolid']),
+          :section_id => section_id,
+          :name => item['name'],
+          :active => (item['active'] == 1),
+          :points => Osm::to_i_or_nil(item['points']),
+        })
+        end
+        cache_write(api, cache_key, result)
       end
-      cache_write(api, cache_key, result)
 
       return result
     end

data/lib/osm/member.rb

@@ -74,7 +74,7 @@ module Osm
     #   @return [Fixnum] the grouping within the section that the member belongs to
     # @!attribute [rw] grouping_leader
     #   @return [Fixnum] whether the member is the grouping leader (0=no, 1=seconder/APL, 2=sixer/PL)
-    # @!attribute [rw] grouping
+    # @!attribute [rw] grouping_label
     #   @return [Fixnum] the grouping within the section that the member belongs to (as displayed in OSM, if member was retrieved from OSM)
     # @!attribute [rw] joined
     #   @return [Date] when the member joined the section
@@ -118,7 +118,7 @@ module Osm
     attribute :custom8, :type => String, :default => ''
     attribute :custom9, :type => String, :default => ''
     attribute :grouping_id, :type => Integer
-    attribute :grouping, :type => String, :default => ''
+    attribute :grouping_label, :type => String, :default => ''
     attribute :grouping_leader, :type => Integer
     attribute :joined, :type => Date
     attribute :age, :type => String
@@ -128,14 +128,14 @@ module Osm
                     :phone1, :phone2, :phone3, :phone4, :address, :address2, :date_of_birth, :started,
                     :joining_in_years, :parents, :notes, :medical, :religion, :school, :ethnicity, :subs,
                     :custom1, :custom2, :custom3, :custom4, :custom5, :custom6, :custom7, :custom8, :custom9,
-                    :grouping_id, :grouping, :grouping_leader, :joined, :age, :joined_years
+                    :grouping_id, :grouping_label, :grouping_leader, :joined, :age, :joined_years
 
     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_numericality_of :grouping_id, :only_integer=>true, :greater_than_or_equal_to=>-2
     validates_numericality_of :grouping_leader, :only_integer=>true, :greater_than_or_equal_to=>0, :less_than_or_equal_to=>2
     validates_numericality_of :joined_years, :only_integer=>true, :greater_than_or_equal_to=>-1, :allow_nil=>true
-    validates_numericality_of :joining_in_years, :only_integer=>true, :greater_than_or_equal_to=>0, :allow_nil=>true
+    validates_numericality_of :joining_in_years, :only_integer=>true, :greater_than_or_equal_to=>-1, :allow_nil=>true
     validates_presence_of :first_name
     validates_presence_of :last_name
     validates_presence_of :date_of_birth
@@ -200,7 +200,7 @@ module Osm
           :custom8 => item['custom8'],
           :custom9 => item['custom9'],
           :grouping_id => Osm::to_i_or_nil(item['patrolid']),
-          :grouping => item['patrol'],
+          :grouping_label => item['patrol'],
           :grouping_leader => Osm::to_i_or_nil(item['patrolleader']),
           :joined => Osm::parse_date(item['joined']),
           :age => item['age'].gsub(' ', ''),
@@ -213,6 +213,20 @@ module Osm
     end
 
 
+    # @deprecated use grouping_label instead
+    # @return [String] the grouping as displayed in OSM
+    # TODO - Use a Grouping object not String when upping the version
+    def grouping
+      return self.grouping_label
+    end
+    # @deprecated use grouping_label instead
+    # TODO - Use a Grouping object not String when upping the version
+    def grouping=(new_grouping)
+      return self.grouping_label = new_grouping
+    end
+
+
+
     # @!method initialize
     #   Initialize a new Member
     #   @param [Hash] attributes the hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
@@ -286,8 +300,6 @@ module Osm
         'dob' => date_of_birth.strftime(Osm::OSM_DATE_FORMAT),
         'started' => started.strftime(Osm::OSM_DATE_FORMAT),
         'startedsection' => joined.strftime(Osm::OSM_DATE_FORMAT),
-        'patrolid' => grouping_id,
-        'patrolleader' => grouping_leader,
         'email1' => email1,
         'email2' => email2,
         'email3' => email3,
@@ -327,6 +339,14 @@ module Osm
         result &= (data[column] == value.to_s)
       end
 
+      data = api.perform_query("users.php?action=updateMemberPatrol", {
+        'scoutid' => self.id,
+        'patrolid' => grouping_id,
+        'pl' => grouping_leader,
+        'sectionid' => section_id,
+      })
+      result &= ((data['patrolid'].to_i == grouping_id) && (data['patrolleader'].to_i == grouping_leader))
+
       return result
     end
 

data/lib/osm/register.rb

@@ -20,17 +20,21 @@ module Osm
       data = api.perform_query("users.php?action=registerStructure&sectionid=#{section_id}&termid=#{term_id}")
 
       structure = []
-      data.each do |item|
-        item['rows'].each do |row|
-          structure.push Field.new(
-            :id => row['field'],
-            :name => row['name'],
-            :tooltip => row['tooltip'],
-          )
+      if data.is_a?(Array)
+        data.each do |item|
+          if item.is_a?(Hash) && item['rows'].is_a?(Array)
+            item['rows'].each do |row|
+              structure.push Field.new(
+                :id => row['field'],
+                :name => row['name'],
+                :tooltip => row['tooltip'],
+              )
+            end
+          end
         end
       end
-      Osm::Model.cache_write(api, cache_key, structure)
 
+      Osm::Model.cache_write(api, cache_key, structure) unless structure.nil?
       return structure
     end
 
@@ -51,23 +55,27 @@ module Osm
 
       data = api.perform_query("users.php?action=register&sectionid=#{section_id}&termid=#{term_id}")
 
-      data = data['items']
       to_return = []
-      data.each do |item|
-        unless item['scoutid'].to_i < 0  # It's a total row
-          to_return.push Osm::Register::Attendance.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'],
-            :total => item['total'].to_i,
-            :attendance => item.select { |key, value| key.to_s.match(Osm::OSM_DATE_REGEX) }.
-                                inject({}){ |new_hash,(date, attendance)| new_hash[Date.strptime(date, Osm::OSM_DATE_FORMAT)] = attendance; new_hash },
-          )
+      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
+              to_return.push Osm::Register::Attendance.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'],
+                :total => item['total'].to_i,
+                :attendance => item.select { |key, value| key.to_s.match(Osm::OSM_DATE_REGEX) }.
+                                    inject({}){ |new_hash,(date, attendance)| new_hash[Date.strptime(date, Osm::OSM_DATE_FORMAT)] = attendance; new_hash },
+              )
+            end
+          end
         end
+        Osm::Model.cache_write(api, cache_key, to_return)
       end
-      Osm::Model.cache_write(api, cache_key, to_return)
       return to_return
     end
 

data/spec/osm/event_spec.rb

@@ -51,6 +51,7 @@ describe "Event" do
     Osm::Event.new(:attendance_limit => 1).limited_attendance?.should be_true
   end
 
+
   it "Create Event::Attendance" do
     data = {
       :member_id => 1,
@@ -204,6 +205,108 @@ describe "Event" do
       event.id.should == 2
     end
 
+    describe "Tells if there are spaces" do
+
+      it "No limit" do
+        event = Osm::Event.new(:attendance_limit => 0, :id => 1, :section_id => 2)
+        event.spaces?(@api).should be_true
+        event.spaces(@api).should == nil
+      end
+
+      it "Under limit" do
+        FakeWeb.register_uri(:post, 'https://www.onlinescoutmanager.co.uk/events.php?action=getEventAttendance&eventid=1&sectionid=2&termid=3', :body => {
+          'identifier' => 'scoutid',
+          'eventid' => '1',
+          'items' => [
+            {
+              'scoutid' => '4',
+              'attending' => 'Yes',
+              'firstname' => 'First',
+              'lastname' => 'Last',
+              'dob' => '1980-01-02',
+              'patrolid' => '2',
+              'f_1' => 'a',
+            },
+          ]
+        }.to_json)
+        Osm::Term.stub(:get_current_term_for_section) { Osm::Term.new(:id => 3) }
+
+        event = Osm::Event.new(:attendance_limit => 2, :id => 1, :section_id => 2)
+        event.spaces?(@api).should be_true
+        event.spaces(@api).should == 1
+      end
+
+      it "Over limit" do
+        FakeWeb.register_uri(:post, 'https://www.onlinescoutmanager.co.uk/events.php?action=getEventAttendance&eventid=1&sectionid=2&termid=3', :body => {
+          'identifier' => 'scoutid',
+          'eventid' => '1',
+          'items' => [
+            {
+              'scoutid' => '4',
+              'attending' => 'Yes',
+              'firstname' => 'First',
+              'lastname' => 'Last',
+              'dob' => '1980-01-02',
+              'patrolid' => '2',
+              'f_1' => 'a',
+            },{
+              'scoutid' => '5',
+              'attending' => 'Yes',
+              'firstname' => 'First',
+              'lastname' => 'Last',
+              'dob' => '1980-01-02',
+              'patrolid' => '2',
+              'f_1' => 'a',
+            },{
+              'scoutid' => '6',
+              'attending' => 'Yes',
+              'firstname' => 'First',
+              'lastname' => 'Last',
+              'dob' => '1980-01-02',
+              'patrolid' => '2',
+              'f_1' => 'a',
+            }
+          ]
+        }.to_json)
+        Osm::Term.stub(:get_current_term_for_section) { Osm::Term.new(:id => 3) }
+
+        event = Osm::Event.new(:attendance_limit => 2, :id => 1, :section_id => 2)
+        event.spaces?(@api).should be_false
+        event.spaces(@api).should == -1
+      end
+
+      it "At limit" do
+        FakeWeb.register_uri(:post, 'https://www.onlinescoutmanager.co.uk/events.php?action=getEventAttendance&eventid=1&sectionid=2&termid=3', :body => {
+          'identifier' => 'scoutid',
+          'eventid' => '1',
+          'items' => [
+            {
+              'scoutid' => '4',
+              'attending' => 'Yes',
+              'firstname' => 'First',
+              'lastname' => 'Last',
+              'dob' => '1980-01-02',
+              'patrolid' => '2',
+              'f_1' => 'a',
+            },{
+              'scoutid' => '5',
+              'attending' => 'Yes',
+              'firstname' => 'First',
+              'lastname' => 'Last',
+              'dob' => '1980-01-02',
+              'patrolid' => '2',
+              'f_1' => 'a',
+            }
+          ]
+        }.to_json)
+        Osm::Term.stub(:get_current_term_for_section) { Osm::Term.new(:id => 3) }
+
+        event = Osm::Event.new(:attendance_limit => 2, :id => 1, :section_id => 2)
+        event.spaces?(@api).should be_false
+        event.spaces(@api).should == 0
+      end
+
+    end
 
     it "Create (succeded)" do
       url = 'https://www.onlinescoutmanager.co.uk/events.php?action=addEvent&sectionid=1'

data/spec/osm/grouping_spec.rb

@@ -3,24 +3,34 @@ require 'spec_helper'
 
 describe "Grouping" do
 
-  it "Create" do
-    body = {'patrols' => [{
-      'patrolid' => 1,
-      'name' => 'Patrol Name',
-      'active' => 1,
-      'points' => '3',
-    }]}
-    FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/users.php?action=getPatrols&sectionid=2", :body => body.to_json)
+  describe "Using the API" do
+
+    it "Create" do
+      body = {'patrols' => [{
+        'patrolid' => 1,
+        'name' => 'Patrol Name',
+        'active' => 1,
+        'points' => '3',
+      }]}
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/users.php?action=getPatrols&sectionid=2", :body => body.to_json)
+
+      patrols = Osm::Grouping.get_for_section(@api, 2)
+      patrols.size.should == 1
+      patrol = patrols[0]
+      patrol.id.should == 1
+      patrol.section_id.should == 2
+      patrol.name.should == 'Patrol Name'
+      patrol.active.should == true
+      patrol.points.should == 3
+      patrol.valid?.should be_true
+    end
+
+    it "Handles no data" do
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/users.php?action=getPatrols&sectionid=2", :body => '')
+      patrols = Osm::Grouping.get_for_section(@api, 2)
+      patrols.size.should == 0
+    end
 
-    patrols = Osm::Grouping.get_for_section(@api, 2)
-    patrols.size.should == 1
-    patrol = patrols[0]
-    patrol.id.should == 1
-    patrol.section_id.should == 2
-    patrol.name.should == 'Patrol Name'
-    patrol.active.should == true
-    patrol.points.should == 3
-    patrol.valid?.should be_true
   end
 
 end

data/spec/osm/member_spec.rb

@@ -41,7 +41,7 @@ describe "Member" do
       :custom9 => 'Custom Field 9',
       :grouping_id => '3',
       :grouping_leader => 0,
-      :grouping => 'Grouping',
+      :grouping_label => 'Grouping',
       :joined => '2006-01-07',
       :age => '06/07',
       :joined_years => 1,
@@ -83,7 +83,7 @@ describe "Member" do
     member.custom8.should == 'Custom Field 8'
     member.custom9.should == 'Custom Field 9'
     member.grouping_id.should == 3
-    member.grouping.should == 'Grouping'
+    member.grouping_label.should == 'Grouping'
     member.grouping_leader.should == 0
     member.joined.should == Date.new(2006, 1, 7)
     member.age.should == '06/07'
@@ -374,17 +374,30 @@ describe "Member" do
       body = (body_data.inject({}) {|h,(k,v)| h[k]=v.to_s; h}).to_json
 
       body_data.each do |column, value|
-        HTTParty.should_receive(:post).with(url, {:body => {
-          'apiid' => @CONFIGURATION[:api][:osm][:id],
-          'token' => @CONFIGURATION[:api][:osm][:token],
-          'userid' => 'user_id',
-          'secret' => 'secret',
-          'scoutid' => member.id,
-          'column' => column,
-          'value' => value,
-          'sectionid' => member.section_id,
-        }}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>body}) }
+        unless ['patrolid', 'patrolleader'].include?(column)
+          HTTParty.should_receive(:post).with(url, {:body => {
+            'apiid' => @CONFIGURATION[:api][:osm][:id],
+            'token' => @CONFIGURATION[:api][:osm][:token],
+            'userid' => 'user_id',
+            'secret' => 'secret',
+            'scoutid' => member.id,
+            'column' => column,
+            'value' => value,
+            'sectionid' => member.section_id,
+          }}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>body}) }
+        end
       end
+      HTTParty.should_receive(:post).with('https://www.onlinescoutmanager.co.uk/users.php?action=updateMemberPatrol', {:body => {
+        'apiid' => @CONFIGURATION[:api][:osm][:id],
+        'token' => @CONFIGURATION[:api][:osm][:token],
+        'userid' => 'user_id',
+        'secret' => 'secret',
+        'scoutid' => member.id,
+        'patrolid' => member.grouping_id,
+        'pl' => member.grouping_leader,
+        'sectionid' => member.section_id,
+      }}) { DummyHttpResult.new(:response=>{:code=>'200', :body=>body}) }
+
       member.update(@api).should be_true
     end
 

data/spec/osm/register_spec.rb

@@ -152,6 +152,19 @@ describe "Register" do
       reg.last_name.should == 'Last'
     end
 
+    it "Handles no data" do
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/users.php?action=registerStructure&sectionid=1&termid=2", :body => '')
+      register_structure = Osm::Register.get_structure(@api, 1, 2)
+      register_structure.is_a?(Array).should be_true
+      register_structure.size.should == 0
+
+
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/users.php?action=register&sectionid=1&termid=2", :body => '')
+      register = Osm::Register.get_attendance(@api, 1, 2)
+      register.is_a?(Array).should be_true
+      register.size.should == 0
+    end
+
   end
 
 end

data/version.rb

@@ -1,3 +1,3 @@
 module Osm
-  VERSION = "0.1.15"
+  VERSION = "0.1.16"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osm
 version: !ruby/object:Gem::Version
-  version: 0.1.15
+  version: 0.1.16
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-21 00:00:00.000000000Z
+date: 2013-02-02 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &83848700 !ruby/object:Gem::Requirement
+  requirement: &88296760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *83848700
+  version_requirements: *88296760
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &83848170 !ruby/object:Gem::Requirement
+  requirement: &88296420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '0.9'
   type: :runtime
   prerelease: false
-  version_requirements: *83848170
+  version_requirements: *88296420
 - !ruby/object:Gem::Dependency
   name: active_attr
-  requirement: &83845760 !ruby/object:Gem::Requirement
+  requirement: &88296130 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.6'
   type: :runtime
   prerelease: false
-  version_requirements: *83845760
+  version_requirements: *88296130
 - !ruby/object:Gem::Dependency
   name: activemodel
-  requirement: &83845500 !ruby/object:Gem::Requirement
+  requirement: &88295670 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *83845500
+  version_requirements: *88295670
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &83845130 !ruby/object:Gem::Requirement
+  requirement: &88295400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '10.0'
   type: :development
   prerelease: false
-  version_requirements: *83845130
+  version_requirements: *88295400
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &83828750 !ruby/object:Gem::Requirement
+  requirement: &88295160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,10 +76,10 @@ dependencies:
         version: '2.11'
   type: :development
   prerelease: false
-  version_requirements: *83828750
+  version_requirements: *88295160
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &83828240 !ruby/object:Gem::Requirement
+  requirement: &88294750 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,7 +87,7 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *83828240
+  version_requirements: *88294750
 description: Use the Online Scout Manager API (https://www.onlinescoutmanager.co.uk)
   to retrieve and save data.
 email: