osm 1.0.6 → 1.2.0

data/lib/osm/model.rb

@@ -159,7 +159,7 @@ module Osm
 
     # Raise an exception if the user does not have the relevant permission
     # @param [Osm::Api] api The api to use to make the request
-    # @param [Symbol] level The OSM subscription level required (e.g. :gold)
+    # @param [Symbol] level The OSM subscription level required (:bronze, :silver, :gold, :gold_plus)
     # @param [Osm::Section, Fixnum, #to_i] section The Section (or its ID) the subscription is required on
     # @!macro options_get
     # @raise [Osm::Forbidden] If the Section does not have the required OSM Subscription (or higher)
@@ -173,12 +173,14 @@ module Osm
           level = 2
         when :gold
           level = 3
+        when :gold_plus
+          level = 4
         else
           level = 0
         end
       end
       if section.nil? || section.subscription_level < level
-        level_name = ['Unknown', 'Bronze', 'Silver', 'Gold'][level] || level
+        level_name = Osm::SUBSCRIPTION_LEVEL_NAMES[level] || level
         raise Osm::Forbidden, "Insufficent OSM subscription level (#{level_name} required for #{section.name})"
       end
     end

data/lib/osm/register.rb

@@ -22,15 +22,14 @@ module Osm
 
       structure = []
       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
+        data = (data.size == 2) ? data[1] : []
+        if data.is_a?(Hash) && data['rows'].is_a?(Array)
+          data['rows'].each do |row|
+            structure.push Field.new(
+              :id => row['field'],
+              :name => row['name'],
+              :tooltip => row['tooltip'],
+            )
           end
         end
       end
@@ -57,7 +56,7 @@ module Osm
 
       data = api.perform_query("users.php?action=register&sectionid=#{section_id}&termid=#{term_id}")
       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_s = dates_s.map{ |f| f.id }
       dates_d = dates_s.map{ |d| Osm::parse_date(d) }
 
       to_return = []
@@ -73,7 +72,6 @@ module Osm
                 attendance[date] = :yes if item_attendance.eql?('Yes')
                 attendance[date] = :advised_absent if item_attendance.eql?('No')
               end
-              item.select{}
               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']),

data/lib/osm/section.rb

@@ -10,7 +10,7 @@ module Osm
     # @!attribute [rw] group_name
     #   @return [String] the group name
     # @!attribute [rw] subscription_level
-    #   @return [Fixnum] what subscription the section has to OSM (1-bronze, 2-silver, 3-gold)
+    #   @return [Fixnum] what subscription the section has to OSM (1-bronze, 2-silver, 3-gold, 4-gold+)
     # @!attribute [rw] subscription_expires
     #   @return [Date] when the section's subscription to OSM expires
     # @!attribute [rw] type
@@ -33,14 +33,18 @@ module Osm
     #   @return [Date] when the subscription to Badges in My.SCOUT expires
     # @!attribute [rw] myscout_programme_expires
     #   @return [Date] when the subscription to Badges in My.SCOUT expires
-    # @!attribute [rw] myscout_events
-    #   @return [Boolean] whether the section uses the Events part of My.SCOUT
+    # @!attribute [rw] myscout_events_expires
+    #   @return [Date] when the subscription to Events in My.SCOUT expires
+    # @!attribute [rw] myscout_details_expires
+    #   @return [Boolean] whether the section uses the Personal Details part of My.SCOUT
     # @!attribute [rw] myscout_badges
     #   @return [Boolean] whether the section uses the Badges part of My.SCOUT
     # @!attribute [rw] myscout_programme
     #   @return [Boolean] whether the section uses the Programme part of My.SCOUT
     # @!attribute [rw] myscout_payments
     #   @return [Boolean] whether the section uses the Payments part of My.SCOUT
+    # @!attribute [rw] myscout_details
+    #   @return [Boolean] whether the section uses the Personal Details part of My.SCOUT
     # @!attribute [rw] myscout_emails
     #   @return [Hash of Symbol to Boolean] which email addresses are linked to MyScout for each Member
     # @!attribute [rw] myscout_email_address_from
@@ -52,7 +56,9 @@ module Osm
     # @!attribute [rw] myscout_programme_summary
     #   @return [Boolean] Wether parents can see summary of programme items
     # @!attribute [rw] myscout_programme_times
-    #   @return [Boolean] Wether parents can see times of programme items
+    #   @return [Boolean] Whether parents can see times of programme items
+    # @!attribute [rw] myscout_programme_show
+    #   @return [Fixnum] How many programme itemms parents can see (the next 5, 10, 15, 20 meetings, -1 (whole term), 0 (remaining this term) or -2 (all future))
     # @!attribute [rw] myscout_event_reminder_count
     #   @return [Fixnum] How many event reminders to send to parents who haven't responded
     # @!attribute [rw] myscout_event_reminder_frequency
@@ -61,6 +67,8 @@ module Osm
     #   @return [Fixnum] How many payment reminders to send to parents who haven't paid yet
     # @!attribute [rw] myscout_payment_reminder_frequency
     #   @return [Fixnum] How many days to leave between payment reminder emails
+    # @!attribute [rw] myscout_details_email_changes_to
+    #   @return [String] email address to send changes to personal details made through My.SCOUT to
     # @!attribute [rw] sms_sent_test
     #   @return [Boolean] Whether the section has sent their test SMS message
     # @!attribute [rw] sms_messages_sent
@@ -84,20 +92,24 @@ module Osm
     attribute :myscout_events_expires, :type => Date
     attribute :myscout_badges_expires, :type => Date
     attribute :myscout_programme_expires, :type => Date
+    attribute :myscout_details_expires, :type => Date
     attribute :myscout_events, :type => Boolean
     attribute :myscout_badges, :type => Boolean
     attribute :myscout_programme, :type => Boolean
     attribute :myscout_payments, :type => Boolean
+    attribute :myscout_details, :type => Boolean
     attribute :myscout_emails, :default => {}
     attribute :myscout_email_address_from, :type => String, :default => ''
     attribute :myscout_email_address_copy, :type => String, :default => ''
     attribute :myscout_badges_partial, :type => Boolean
     attribute :myscout_programme_summary, :type => Boolean
     attribute :myscout_programme_times, :type => Boolean
+    attribute :myscout_programme_show, :type => Integer, :default => 0
     attribute :myscout_event_reminder_count, :type => Integer
     attribute :myscout_event_reminder_frequency, :type => Integer
     attribute :myscout_payment_reminder_count, :type => Integer
     attribute :myscout_payment_reminder_frequency, :type => Integer
+    attribute :myscout_details_email_changes_to, :type => String, :default => ''
     attribute :sms_sent_test, :type => Boolean, :default => false
     attribute :sms_messages_sent, :type => Integer, :default => 0
     attribute :sms_messages_remaining, :type => Integer, :default => 0
@@ -105,12 +117,13 @@ module Osm
     attr_accessible :id, :name, :group_id, :group_name, :subscription_level, :subscription_expires,
                     :type, :column_names, :fields, :intouch_fields, :mobile_fields, :flexi_records,
                     :gocardless, :myscout_events_expires, :myscout_badges_expires,
-                    :myscout_programme_expires, :myscout_events, :myscout_badges,
-                    :myscout_programme, :myscout_payments, :myscout_emails,
-                    :myscout_email_address_from, :myscout_email_address_copy,
+                    :myscout_programme_expires, :myscout_details_expires, :myscout_events,
+                    :myscout_badges, :myscout_programme, :myscout_payments, :myscout_details,
+                    :myscout_emails, :myscout_email_address_from, :myscout_email_address_copy,
                     :myscout_badges_partial, :myscout_programme_summary, :myscout_programme_times,
-                    :myscout_event_reminder_count, :myscout_event_reminder_frequency,
-                    :myscout_payment_reminder_count, :myscout_payment_reminder_frequency,
+                    :myscout_programme_show, :myscout_event_reminder_count,
+                    :myscout_event_reminder_frequency, :myscout_payment_reminder_count,
+                    :myscout_payment_reminder_frequency, :myscout_details_email_changes_to,
                     :sms_sent_test, :sms_messages_sent, :sms_messages_remaining
 
     validates_numericality_of :id, :only_integer=>true, :greater_than=>0, :allow_nil => true
@@ -127,11 +140,11 @@ module Osm
     validates_presence_of :subscription_level
     validates_presence_of :subscription_expires
     validates_presence_of :type
-    validates_presence_of :column_names, :unless => Proc.new { |a| a.column_names == {} }
-    validates_presence_of :fields, :unless => Proc.new { |a| a.fields == {} }
-    validates_presence_of :intouch_fields, :unless => Proc.new { |a| a.intouch_fields == {} }
-    validates_presence_of :mobile_fields, :unless => Proc.new { |a| a.mobile_fields == {} }
-    validates_presence_of :flexi_records, :unless => Proc.new { |a| a.flexi_records == [] }
+#    validates_presence_of :column_names, :unless => Proc.new { |a| a.column_names == {} }
+#    validates_presence_of :fields, :unless => Proc.new { |a| a.fields == {} }
+#    validates_presence_of :intouch_fields, :unless => Proc.new { |a| a.intouch_fields == {} }
+#    validates_presence_of :mobile_fields, :unless => Proc.new { |a| a.mobile_fields == {} }
+#    validates_presence_of :flexi_records, :unless => Proc.new { |a| a.flexi_records == [] }
 
     validates_inclusion_of :subscription_level, :in => (1..3), :message => 'is not a valid subscription level'
     validates_inclusion_of :gocardless, :in => [true, false]
@@ -139,9 +152,11 @@ module Osm
     validates_inclusion_of :myscout_badges, :in => [true, false]
     validates_inclusion_of :myscout_programme, :in => [true, false]
     validates_inclusion_of :myscout_payments, :in => [true, false]
+    validates_inclusion_of :myscout_details, :in => [true, false]
     validates_inclusion_of :myscout_badges_partial, :in => [true, false]
     validates_inclusion_of :myscout_programme_summary, :in => [true, false]
     validates_inclusion_of :myscout_programme_times, :in => [true, false]
+    validates_inclusion_of :myscout_programme_show, :in => [-2, -1, 0, 5, 10, 15, 20]
     validates_inclusion_of :sms_sent_test, :in => [true, false]
 
     validates :column_names, :hash => {:key_type => Symbol, :value_type => String}
@@ -215,20 +230,24 @@ module Osm
             :myscout_events_expires => Osm::parse_date(section_data['portalExpires']['events']),
             :myscout_badges_expires => Osm::parse_date(section_data['portalExpires']['badges']),
             :myscout_programme_expires => Osm::parse_date(section_data['portalExpires']['programme']),
+            :myscout_details_expires => Osm::parse_date(section_data['portalExpires']['details']),
             :myscout_events => myscout_data['events'] == 1,
             :myscout_badges => myscout_data['badges'] == 1,
             :myscout_programme => myscout_data['programme'] == 1,
             :myscout_payments => myscout_data['payments'] == 1,
+            :myscout_details => myscout_data['details'] == 1,
             :myscout_emails => (myscout_data['emails'] || {}).inject({}) { |n,(k,v)| n[k.to_sym] = v.eql?('true'); n},
             :myscout_email_address_from => myscout_data['emailAddress'] ? myscout_data['emailAddress'] : '',
             :myscout_email_address_copy => myscout_data['emailAddressCopy'] ? myscout_data['emailAddressCopy'] : '',
             :myscout_badges_partial => myscout_data['badgesPartial'] == 1,
             :myscout_programme_summary => myscout_data['programmeSummary'] == 1,
             :myscout_programme_times => myscout_data['programmeTimes'] == 1,
+            :myscout_programme_show => myscout_data['programmeShow'].to_i,
             :myscout_event_reminder_count => myscout_data['eventRemindCount'].to_i,
             :myscout_event_reminder_frequency => myscout_data['eventRemindFrequency'].to_i,
             :myscout_payment_reminder_count => myscout_data['paymentRemindCount'].to_i,
             :myscout_payment_reminder_frequency => myscout_data['paymentRemindFrequency'].to_i,
+            :myscout_details_email_changes_to => myscout_data['contactNotificationEmail'],
             :sms_sent_test => section_data['hasSentTestSMS'],
             :sms_messages_sent => section_data['sms_sent'],
             :sms_messages_remaining => section_data['sms_remaining'],
@@ -348,12 +367,10 @@ module Osm
 
     # Get the name for the section's subscription level
     # @return [String, nil] the name of the subscription level (nil if no name exists)
+    # @deprecated Please use Osm::SUBSCRIPTION_LEVEL_NAMES[section.subscription_level instead
     def subscription_level_name
-      return {
-        1 => 'Bronze',
-        2 => 'Silver',
-        3 => 'Gold',
-      }[subscription_level]
+      warn "[DEPRECATION] `subscription_level_name` is deprecated.  Please use `Osm::SUBSCRIPTION_LEVEL_NAMES[section.subscription_level` instead."
+      Osm::SUBSCRIPTION_LEVEL_NAMES[subscription_level]
     end
 
     # Compare Section based on group_name type (age order), then name

data/lib/osm/sms.rb

@@ -6,19 +6,20 @@ 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 send the message to
     # @param [Array<Osm::Member, Fixnum, #to_i>, Osm::Member, Fixnum, #to_i] members The members (or their IDs) to send the message to
-    # @param [Symbol] all_or_one Wheather to send the message to all numbers for a member (:all) or just the first mobile one (:one)
+    # @param [Symbol, String] mobile_numbers Wheather to send the message to all numbers for a member (:all) or just the first mobile one (:first) or a selection (e.g. "12", "24" etc.)
     # @param [String, #to_s] source_address The number to claim the message is from
     # @param [String, #to_s] message The text of the message to send
     # @return [Hash] with keys :sent (Fixnum), :result (Boolean) and :message (String)
-    def self.send_sms(api, section, members, all_or_one, source_address, message)
-      raise ArgumentError, 'all_or_one must be either :all or :one' unless [:all, :one].include?(all_or_one)
-      Osm::Model.require_access_to_section(api, section)
+    def self.send_sms(api, section, members, mobile_numbers, source_address, message)
+      raise ArgumentError, 'mobile_numbers must be either :all, :first or a String containing numbers 1-4' unless ([:all, :first, :one].include?(mobile_numbers) || mobile_numbers.match(/[1234]{1,4}/))
+      Osm::Model.require_access_to_section(api, section)      
+      mobile_numbers = :one if mobile_numbers.eql?(:first)
 
       data = api.perform_query("sms.php?action=sendText&sectionid=#{section.to_i}", {
         'msg' => message,
         'scouts' => [*members].join(','),
         'source' => source_address,
-        'all' => all_or_one,
+        'type' => mobile_numbers,
         'scheduled' => 'now',
       })
 

data/lib/osm/term.rb

@@ -104,7 +104,7 @@ module Osm
     # @param [Osm::Section, Fixnum, #to_i] section The section (or its ID)  to get terms for
     # @!macro options_get 
     # @return [Osm::Term, nil] The current term or nil if the user can not access that section
-    # @raise [Osm::Error] If the term doesn't have a Term which is current
+    # @raise [Osm::Error::NoCurrentTerm] If the Section doesn't have a Term which is current
     def self.get_current_term_for_section(api, section, options={})
       section_id = section.to_i
       terms = get_for_section(api, section_id, options)
@@ -114,7 +114,7 @@ module Osm
         return term if term.current?
       end
 
-      raise Osm::Error, 'There is no current term for the section.'
+      raise Osm::Error::NoCurrentTerm, 'There is no current term for the section.'
     end
 
     # Create a term in OSM

data/spec/osm/budget_spec.rb

@@ -0,0 +1,205 @@
+# encoding: utf-8
+require 'spec_helper'
+
+
+describe "Budget" do
+
+  it "Create Budget" do
+    b = Osm::Budget.new(
+      :id => 1,
+      :section_id => 2,
+      :name => 'Name',
+    )
+
+    b.id.should == 1
+    b.section_id.should == 2
+    b.name.should == 'Name'
+    b.valid?.should be_true
+  end
+
+  it "Sorts Budget by section ID then name" do
+    b1 = Osm::Budget.new(:section_id => 1, :name => 'a')
+    b2 = Osm::Budget.new(:section_id => 2, :name => 'a')
+    b3 = Osm::Budget.new(:section_id => 2, :name => 'b')
+
+    data = [b2, b3, b1]
+    data.sort.should == [b1, b2, b3]
+  end
+
+
+  describe "Using the API" do
+
+    it "Get budgets for section" do
+      data = {
+        "identifier" => "categoryid",
+        "items" => [
+          {
+            "categoryid" => "2",
+            "sectionid" => "3",
+            "name" => "Name",
+            "archived" => "1"
+          }
+        ]
+      }
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/finances.php?action=getCategories&sectionid=3", :body => data.to_json)
+
+      budgets = Osm::Budget.get_for_section(@api, 3)
+      budgets.should == [Osm::Budget.new(:id => 2, :section_id => 3, :name => 'Name')]
+    end
+
+    it "Create budget (success)" do
+      budget = Osm::Budget.new(
+        :section_id => 2,
+        :name => 'Budget Name',
+      )
+
+      url = "https://www.onlinescoutmanager.co.uk/finances.php?action=addCategory&sectionid=2"
+      HTTParty.should_receive(:post).with(url, :body => {
+        'apiid' => @CONFIGURATION[:api][:osm][:id],
+        'token' => @CONFIGURATION[:api][:osm][:token],
+        'userid' => 'user_id',
+        'secret' => 'secret',
+      }) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body => '{"ok":true}'}) }
+      Osm::Budget.should_receive(:get_for_section).with(@api, 2, {:no_cache=>true}) { [Osm::Budget.new(:id => 3, :section_id => 2, :name => 'Existing budget'), Osm::Budget.new(:id => 4, :section_id => 2, :name => '** Unnamed **')] }
+      url = "https://www.onlinescoutmanager.co.uk/finances.php?action=updateCategory&sectionid=2"
+      HTTParty.should_receive(:post).with(url, :body => {
+        'apiid' => @CONFIGURATION[:api][:osm][:id],
+        'token' => @CONFIGURATION[:api][:osm][:token],
+        'userid' => 'user_id',
+        'secret' => 'secret',
+        'categoryid' => 4,
+        'column' => 'name',
+        'value' => 'Budget Name',
+        'section_id' => 2,
+        'row' => 0,
+      }) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body => '{"ok":true}'}) }
+
+      budget.create(@api).should be_true
+      budget.id.should == 4
+    end
+
+    it "Create budget (failure (not created))" do
+      budget = Osm::Budget.new(
+        :section_id => 2,
+        :name => 'Budget Name',
+      )
+    
+      url = "https://www.onlinescoutmanager.co.uk/finances.php?action=addCategory&sectionid=2"
+      HTTParty.should_receive(:post).with(url, :body => {
+        'apiid' => @CONFIGURATION[:api][:osm][:id],
+        'token' => @CONFIGURATION[:api][:osm][:token],
+        'userid' => 'user_id',
+        'secret' => 'secret',
+      }) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body => '{"ok":true}'}) }
+      Osm::Budget.should_receive(:get_for_section).with(@api, 2, {:no_cache=>true}) { [Osm::Budget.new(:id => 3, :section_id => 2, :name => 'Existing budget')] }
+
+      budget.create(@api).should be_false
+    end
+    
+    it "Create budget (failure (not updated))" do
+      budget = Osm::Budget.new(
+        :section_id => 2,
+        :name => 'Budget Name',
+      )
+    
+      url = "https://www.onlinescoutmanager.co.uk/finances.php?action=addCategory&sectionid=2"
+      HTTParty.should_receive(:post).with(url, :body => {
+        'apiid' => @CONFIGURATION[:api][:osm][:id],
+        'token' => @CONFIGURATION[:api][:osm][:token],
+        'userid' => 'user_id',
+        'secret' => 'secret',
+      }) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body => '{"ok":true}'}) }
+      Osm::Budget.should_receive(:get_for_section).with(@api, 2, {:no_cache=>true}) { [Osm::Budget.new(:id => 3, :section_id => 2, :name => '** Unnamed **')] }
+      url = "https://www.onlinescoutmanager.co.uk/finances.php?action=updateCategory&sectionid=2"
+      HTTParty.should_receive(:post).with(url, :body => {
+        'apiid' => @CONFIGURATION[:api][:osm][:id],
+        'token' => @CONFIGURATION[:api][:osm][:token],
+        'userid' => 'user_id',
+        'secret' => 'secret',
+        'categoryid' => 3,
+        'column' => 'name',
+        'value' => 'Budget Name',
+        'section_id' => 2,
+        'row' => 0,
+      }) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body => '{"ok":false}'}) }
+
+      budget.create(@api).should be_false
+    end
+    
+    it "Update budget (success)" do
+      budget = Osm::Budget.new(
+        :id => 1,
+        :section_id => 2,
+        :name => 'Budget Name',
+      )
+    
+      url = "https://www.onlinescoutmanager.co.uk/finances.php?action=updateCategory&sectionid=2"
+      HTTParty.should_receive(:post).with(url, :body => {
+        'apiid' => @CONFIGURATION[:api][:osm][:id],
+        'token' => @CONFIGURATION[:api][:osm][:token],
+        'userid' => 'user_id',
+        'secret' => 'secret',
+        'categoryid' => 1,
+        'column' => 'name',
+        'value' => 'Budget Name',
+        'section_id' => 2,
+        'row' => 0,
+      }) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body => '{"ok":true}'}) }
+    
+      budget.update(@api).should be_true
+    end
+    
+    it "Update budget (failure)" do
+      budget = Osm::Budget.new(
+        :id => 1,
+        :section_id => 2,
+        :name => 'Budget Name',
+      )
+
+      HTTParty.should_receive(:post) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body => '{"ok":false}'}) }
+    
+      budget.update(@api).should be_false
+    end
+    
+    it "Delete budget (success)" do
+      budget = Osm::Budget.new(
+        :id => 1,
+        :section_id => 2,
+        :name => 'Budget Name',
+      )
+    
+      url = "https://www.onlinescoutmanager.co.uk/finances.php?action=deleteCategory&sectionid=2"
+      HTTParty.should_receive(:post).with(url, :body => {
+        'apiid' => @CONFIGURATION[:api][:osm][:id],
+        'token' => @CONFIGURATION[:api][:osm][:token],
+        'userid' => 'user_id',
+        'secret' => 'secret',
+        'categoryid' => 1,
+      }) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body => '{"ok":true}'}) }
+    
+      budget.delete(@api).should be_true
+    end
+    
+    it "Delete budget (failure)" do
+      budget = Osm::Budget.new(
+        :id => 1,
+        :section_id => 2,
+        :name => 'Budget Name',
+      )
+    
+      url = "https://www.onlinescoutmanager.co.uk/finances.php?action=deleteCategory&sectionid=2"
+      HTTParty.should_receive(:post).with(url, :body => {
+        'apiid' => @CONFIGURATION[:api][:osm][:id],
+        'token' => @CONFIGURATION[:api][:osm][:token],
+        'userid' => 'user_id',
+        'secret' => 'secret',
+        'categoryid' => 1,
+      }) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body => '{"ok":false}'}) }
+    
+      budget.delete(@api).should be_false
+    end
+    
+  end
+
+
+end