osm 1.2.18.dev.4 → 1.2.18.dev.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NjNiMTE0Mzc1NGY0Njk2M2RlODNhOTQzN2M1ZWQxZTZiYWYzYWY5Ng==
+    NTVmYTI0ZmYzMWMyNmQ0NDBmY2VhZGQ4MDJjYTZiZTBmYjdiYjU0Yg==
   data.tar.gz: !binary |-
-    MGYzNzkyM2EwMmE0MzUyMTdjN2ExMjNhMDQyOTU2ZTI2ODZmOTJjOA==
+    NDRjN2MxMjlkYjc4OWYyYmE4N2VkOThhMDM0N2QyYjI1MzUxZjM0ZA==
 SHA512:
   metadata.gz: !binary |-
-    ZmM5YzYwZThmZmIwMjNjOGJhNjk5YjUxMzExODYyNmQ3M2MyNzQ3YTRmNDUw
-    M2E4YjRkNGU1ZDMyZmQ0Y2E3YWYzMWI4OGZjMjA4Y2FmZWNhODM2YTIwOTQx
-    N2JjYmY5NTQ4ZTcxMGZlMDgxNzQ2YWY1ZTZmNTg3M2QxN2U2Y2I=
+    OTc0MDVhMjIxZjQ0M2ZhNzIxOWQ2M2NjNTk5MmQyY2JhMmE2NGE3ZWExY2Vm
+    YzI0ZDkxMTZhOWNhOWQ0MzgwM2UyNTQ3YWU0ZDk2MWFlNjllMzNkZDQwODJi
+    MDIyZDEwMDM4NjFhODQ1NWNmYjI2OTJkMzY2N2ZjZDFkZGZkOTc=
   data.tar.gz: !binary |-
-    NzFjYzc0MjBhY2JhNmQ1ZGZmMjUxMDU0YzI2ZmJjN2YyNGNkOWU4Y2JkYmI1
-    ZjRhNmVlNjIwNDg5NzM3MDE5ZWI3OGY3OTM1ZmUwZDBmY2VmZDBhYjI1ODQx
-    MjdkODlmNjlhODU5YThlYTdlYzA4N2Q2ZDM2ZmNiOGQxNjRlYzI=
+    NWZiZDdlYzViMjBhYzc1NjZjZGE2ZjhjMjBjMmYzZDdiNGM3ZmE5NTkzYmE2
+    OGNjYzhlMWI2YjdlOGIwN2RkODRiZjJlNjliMmVkNWZhMmM4ZGRlYWFiMDFi
+    ZTYwYTQxYWY0NTM1MmY4YWUzMGZjYWI3MWUwY2M1MjIxNDQ5NTg=

data/CHANGELOG.md

@@ -1,7 +1,7 @@
 ## Version 1.2.18
 
   * THIS IS A DEVELOPMENT VERSION OF THIS RELEASE. IT EXISTS ONLY SO YOU CAN PLAY WITH THE NEW STRUCTIRE OF MEMBERS YOU'LL GET WHEN OSM CHANGES. WRITING CHANGES BACK TO OSM HAS NOT YET BEEN UPDATED.
-  * Osm::Section - removal of column_names, fields, intouch_fields, mobile_fields attributes
+  * Osm::Section - removal of column_names, fields, intouch_fields, mobile_fields and sms_* attributes
   * Osm::Member - lots of changes to reflect OSM's new structure for member's details (main ones listed below):
     * Removal of type attribute (I never could work out what it represented)
     * Removal of data attributes except:
@@ -32,6 +32,11 @@
       * all_phones, enabled_phones
     * Validation changes:
       * age should now be in the format 'yy / mm' not 'yy/mm'
+  * Osm::Sms:
+    * send_sms method losses mobile_numbers argumant (OSM now sends to all enabled numbers for all contacts for the member)
+    * send_sms method now just returns a boolean to indicate success/failure
+    * Addition of remaining_credits(api, section, options={}) method
+    * Addition of number_selected(api, section, members, options={}) method to tell how many numbers a message would be sent to
 
 ## Version 1.2.17
 

data/lib/osm/section.rb

@@ -61,12 +61,7 @@ module Osm
     #   @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
-    #   @return [Fixnum] How many SMS messages have been sent by the section
-    # @!attribute [rw] sms_messages_remaining
-    #   @return [Fixnum] How many SMS messages the section can send before needing to topup
+
 
     attribute :id, :type => Integer
     attribute :name, :type => String
@@ -98,9 +93,6 @@ module Osm
     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
 
     if ActiveModel::VERSION::MAJOR < 4
       attr_accessible :id, :name, :group_id, :group_name, :subscription_level, :subscription_expires,
@@ -112,8 +104,7 @@ module Osm
                       :myscout_badges_partial, :myscout_programme_summary, :myscout_programme_times,
                       :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
+                      :myscout_payment_reminder_frequency, :myscout_details_email_changes_to
     end
 
     validates_numericality_of :id, :only_integer=>true, :greater_than=>0, :allow_nil => true
@@ -122,8 +113,6 @@ module Osm
     validates_numericality_of :myscout_event_reminder_frequency, :only_integer=>true, :greater_than_or_equal_to=>-1
     validates_numericality_of :myscout_payment_reminder_count, :only_integer=>true, :greater_than_or_equal_to=>-1
     validates_numericality_of :myscout_payment_reminder_frequency, :only_integer=>true, :greater_than_or_equal_to=>-1
-    validates_numericality_of :sms_messages_sent, :only_integer=>true, :greater_than_or_equal_to=>0
-    validates_numericality_of :sms_messages_remaining, :only_integer=>true, :greater_than_or_equal_to=>0
     validates_presence_of :name
     validates_presence_of :group_name
     validates_presence_of :subscription_level
@@ -142,7 +131,6 @@ module Osm
     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 :myscout_emails, :hash => {:key_in => [:email1, :email2, :email3, :email4], :value_in => [true, false]}
     validates :flexi_records, :array_of => {:item_type => Osm::FlexiRecord, :item_valid => true}
@@ -227,9 +215,6 @@ module Osm
           :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'],
         )
 
         result.push section

data/lib/osm/sms.rb

@@ -2,39 +2,75 @@ module Osm
 
   class Sms
 
-    # Get delivery reports
+    # Send an SMS to some members on their enabled numbers
     # @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, 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, 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}", {
+    # @return [Boolean] whether the messages were sent
+    # @raise [Osm::Error] If the section doesn't have enough credits to send the message
+    def self.send_sms(api, section, members, source_address, message)
+      Osm::Model.require_access_to_section(api, section)
+      raise Osm::Error, 'You do not have enough credits to send that message.' if number_selected(api, section, members) > remaining_credits(api, section) 
+
+      members = [*members]
+      data = api.perform_query("ext/members/sms/?action=sendText&sectionid=#{section.to_i}", {
         'msg' => message,
-        'scouts' => [*members].join(','),
+        'scouts' => [*members.map{ |m| m.to_i }].join(','),
         'source' => source_address,
-        'type' => mobile_numbers,
-        'scheduled' => 'now',
+        'type' => '',
       })
 
-      data.select!{ |k,v| !['debug', 'config'].include?(k) }
-      data = data.map do |k,v|
-        k = 'message' if k.eql?('msg')
-        k = 'sent' if k.eql?('sent_to')
-        [k.to_sym, v]
+      if data.is_a?(Hash) && data['result']
+        Osm::Model.cache_write(api, ['sms_credits', section.to_i], data['msg'].match(/\A[^\d]*(\d+)[^\d]*\Z/)[1])
+        return true
       end
-      return Hash[*data.flatten]
+      return false
+    end
+
+    # Get the number of remaining SMS credits for a section
+    # @param [Osm::Api] api The api to use to make the request
+    # @param [Osm::Section, Fixnum, #to_i] section The section (or its ID) to send the message to
+    # @!macro options_get
+    # @return [Fixnum] the number of remaining SMS credits for the section
+    def self.remaining_credits(api, section, options={})
+      Osm::Model.require_access_to_section(api, section) 
+      cache_key = ['sms_credits', section.to_i]
+
+      if !options[:no_cache] && Osm::Model.cache_exist?(api, cache_key)
+        return Osm::Model.cache_read(api, cache_key)
+      end
+
+      data = api.perform_query("ext/members/sms/?action=getNumbers&sectionid=#{section.to_i}&type=", {
+        'scouts' => '0'
+      })
+      data = data['sms_remaining']
+
+      Osm::Model.cache_write(api, cache_key, data)
+      return data
     end
 
+    # Get the number of SMS credits which will be used sending a message to the passed 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 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
+    # @return [Fixnum] the number of SMS credits which will be used
+    def self.number_selected(api, section, members)
+      Osm::Model.require_access_to_section(api, section) 
 
+      members = [*members]
+      data = api.perform_query("ext/members/sms/?action=getNumbers&sectionid=#{section.to_i}&type=", {
+        'scouts' => [*members.map{ |m| m.to_i }].join(',')
+      })
+
+      Osm::Model.cache_write(api, ['sms_credits', section.to_i], data['sms_remaining'])
+      return data['numbers']
+    end
 
     class DeliveryReport < Osm::Model
+      VALID_STATUSES = [:sent, :not_sent, :delivered, :not_delivered, :invalid_destination_address, :invalid_source_address, :invalid_message_format, :route_not_available, :not_allowed]
+
       # @!attribute [rw] sms_id
       #   @return [Fixnum] the id of the SMS
       # @!attribute [rw] user_id
@@ -92,7 +128,6 @@ module Osm
       validates_presence_of :message
       validates_presence_of :scheduled
       validates_presence_of :last_updated
-      VALID_STATUSES = [:sent, :not_sent, :delivered, :not_delivered, :invalid_destination_address, :invalid_source_address, :invalid_message_format, :route_not_available, :not_allowed]
       validates_inclusion_of :status, :in => VALID_STATUSES
 
 

data/spec/osm/section_spec.rb

@@ -38,9 +38,6 @@ describe "Section" do
       :myscout_payment_reminder_frequency => 7,
       :myscout_details => true,
       :myscout_details_email_changes_to => 'notify-changes-to@example.com',
-      :sms_sent_test => true,
-      :sms_messages_sent => 8,
-      :sms_messages_remaining => 9,
     }
   end
 
@@ -78,9 +75,6 @@ describe "Section" do
     section.myscout_payment_reminder_frequency.should == 7
     section.myscout_details.should == true
     section.myscout_details_email_changes_to.should == 'notify-changes-to@example.com'
-    section.sms_sent_test.should == true
-    section.sms_messages_sent.should == 8
-    section.sms_messages_remaining.should == 9
     section.valid?.should == true
   end
 
@@ -96,9 +90,6 @@ describe "Section" do
     section.myscout_email_address_copy.should == ''
     section.myscout_details_email_changes_to.should == ''
     section.myscout_programme_show.should == 0
-    section.sms_sent_test.should == false
-    section.sms_messages_sent.should == 0
-    section.sms_messages_remaining.should == 0
   end
 
 
@@ -150,9 +141,6 @@ describe "Section" do
         section.myscout_payment_reminder_frequency.should == 7
         section.myscout_details.should == true
         section.myscout_details_email_changes_to.should == 'notify-changes-to@example.com'
-        section.sms_sent_test.should == true
-        section.sms_messages_remaining.should == 8
-        section.sms_messages_sent.should == 9
         section.valid?.should == true
       end
 

data/spec/osm/sms_spec.rb

@@ -5,124 +5,121 @@ describe "SMS" do
 
   describe "Send an SMS" do
 
-    it "First" do
-      HTTParty.should_receive(:post).with('https://www.onlinescoutmanager.co.uk/sms.php?action=sendText&sectionid=1', {:body => {
+    it "One person" do
+      Osm::Sms.stub(:number_selected) { 3 }
+      Osm::Sms.stub(:remaining_credits) { 3 }
+
+      HTTParty.should_receive(:post).with('https://www.onlinescoutmanager.co.uk/ext/members/sms/?action=sendText&sectionid=1', {:body => {
         'apiid' => @CONFIGURATION[:api][:osm][:id],
         'token' => @CONFIGURATION[:api][:osm][:token],
         'userid' => 'user_id',
         'secret' => 'secret',
         'msg' => 'Test message.',
-        'scouts' => '2,3',
+        'scouts' => '4',
         'source' => '441234567890',
-        'type' => :one,
-        'scheduled' => 'now',
-      }}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>{'result'=>true,'sent'=>2,'message'=>'Success','debug'=>nil,'config'=>{}}.to_json}) }
+        'type' => '',
+      }}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>{"result" => true, "msg" => "Message sent - you have <b>131<\/b> credits left.", "config" => {}}.to_json}) }
 
       result = Osm::Sms.send_sms(
         @api,
         1,      # Section
-        [2, 3], # Members
-        :first,
+        4,      # Members
         '441234567890', # Source address
         'Test message.' # Message text
       )
 
-      result.should == {
-        :result => true,
-        :sent => 2,
-        :message => 'Success'
-      }
+      result.should == true
     end
 
-    it "All" do
-      HTTParty.should_receive(:post).with('https://www.onlinescoutmanager.co.uk/sms.php?action=sendText&sectionid=1', {:body => {
+    it "Several people" do
+      Osm::Sms.stub(:number_selected) { 3 }
+      Osm::Sms.stub(:remaining_credits) { 3 }
+
+      HTTParty.should_receive(:post).with('https://www.onlinescoutmanager.co.uk/ext/members/sms/?action=sendText&sectionid=1', {:body => {
         'apiid' => @CONFIGURATION[:api][:osm][:id],
         'token' => @CONFIGURATION[:api][:osm][:token],
         'userid' => 'user_id',
         'secret' => 'secret',
-        'msg' => 'Test message.',
+        'msg' => 'This is a test message.',
         'scouts' => '2,3',
         'source' => '441234567890',
-        'type' => :all,
-        'scheduled' => 'now',
-      }}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>{'result'=>true,'sent'=>2,'message'=>'Success','debug'=>nil,'config'=>{}}.to_json}) }
+        'type' => '',
+      }}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>{"result" => true, "msg" => "Message sent - you have <b>95<\/b> credits left.", "config" => {}}.to_json}) }
 
       result = Osm::Sms.send_sms(
         @api,
         1,      # Section
         [2, 3], # Members
-        :all,
         '441234567890', # Source address
-        'Test message.' # Message text
+        'This is a test message.' # Message text
       )
 
-      result.should == {
-        :result => true,
-        :sent => 2,
-        :message => 'Success'
-      }
+      result.should == true
     end
 
-    it "2 & 3" do
-      HTTParty.should_receive(:post).with('https://www.onlinescoutmanager.co.uk/sms.php?action=sendText&sectionid=1', {:body => {
+    it "Failed" do
+      Osm::Sms.stub(:number_selected) { 3 }
+      Osm::Sms.stub(:remaining_credits) { 3 }
+
+      HTTParty.should_receive(:post).with('https://www.onlinescoutmanager.co.uk/ext/members/sms/?action=sendText&sectionid=1', {:body => {
         'apiid' => @CONFIGURATION[:api][:osm][:id],
         'token' => @CONFIGURATION[:api][:osm][:token],
         'userid' => 'user_id',
         'secret' => 'secret',
         'msg' => 'Test message.',
-        'scouts' => '2,3',
+        'scouts' => '4',
         'source' => '441234567890',
-        'type' => '23',
-        'scheduled' => 'now',
-      }}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>{'result'=>true,'sent'=>2,'message'=>'Success','debug'=>nil,'config'=>{}}.to_json}) }
+        'type' => '',
+      }}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>{"result" => false,"config" => {}}.to_json}) }
 
       result = Osm::Sms.send_sms(
         @api,
         1,      # Section
-        [2, 3], # Members
-        '23',
+        [4],    # Members
         '441234567890', # Source address
         'Test message.' # Message text
       )
 
-      result.should == {
-        :result => true,
-        :sent => 2,
-        :message => 'Success'
-      }
+      result.should == false
     end
 
-    it "1 & 4" do
-      HTTParty.should_receive(:post).with('https://www.onlinescoutmanager.co.uk/sms.php?action=sendText&sectionid=1', {:body => {
-        'apiid' => @CONFIGURATION[:api][:osm][:id],
-        'token' => @CONFIGURATION[:api][:osm][:token],
-        'userid' => 'user_id',
-        'secret' => 'secret',
-        'msg' => 'Test message.',
-        'scouts' => '2,3',
-        'source' => '441234567890',
-        'type' => '14',
-        'scheduled' => 'now',
-      }}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>{'result'=>true,'sent'=>2,'message'=>'Success','debug'=>nil,'config'=>{}}.to_json}) }
+    it "Raises error if not enough credits" do
+      Osm::Sms.stub(:number_selected) { 3 }
+      Osm::Sms.stub(:remaining_credits) { 2 }
 
-      result = Osm::Sms.send_sms(
-        @api,
-        1,      # Section
-        [2, 3], # Members
-        '14',
-        '441234567890', # Source address
-        'Test message.' # Message text
-      )
+      HTTParty.should_not_receive(:post)
 
-      result.should == {
-        :result => true,
-        :sent => 2,
-        :message => 'Success'
-      }
+      expect {
+        Osm::Sms.send_sms(@api, 1, [2, 3], '441234567890', 'Test message.')
+      }.to raise_error(Osm::Error, 'You do not have enough credits to send that message.')
     end
 
   end
 
+  it "Gets remaining credits" do
+    HTTParty.should_receive(:post).with('https://www.onlinescoutmanager.co.uk/ext/members/sms/?action=getNumbers&sectionid=4&type=', {:body => {
+      'apiid' => @CONFIGURATION[:api][:osm][:id],
+      'token' => @CONFIGURATION[:api][:osm][:token],
+      'userid' => 'user_id',
+      'secret' => 'secret',
+      'scouts' => '0',
+    }}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"members":0,"numbers":0,"sms_remaining":5}'}) }
+
+    Osm::Sms.remaining_credits(@api, 4).should == 5
+  end
+
+  it "Gets selected numbers" do
+    HTTParty.should_receive(:post).with('https://www.onlinescoutmanager.co.uk/ext/members/sms/?action=getNumbers&sectionid=4&type=', {:body => {
+      'apiid' => @CONFIGURATION[:api][:osm][:id],
+      'token' => @CONFIGURATION[:api][:osm][:token],
+      'userid' => 'user_id',
+      'secret' => 'secret',
+      'scouts' => '12,56',
+    }}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>'{"members":2,"numbers":3,"sms_remaining":5}'}) }
+
+    Osm::Sms.number_selected(@api, 4, [12, 56]).should == 3
+  end
+
 
   describe "Delivery Report" do
 

data/version.rb

@@ -1,3 +1,3 @@
 module Osm
-  VERSION = "1.2.18.dev.4"
+  VERSION = "1.2.18.dev.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: osm
 version: !ruby/object:Gem::Version
-  version: 1.2.18.dev.4
+  version: 1.2.18.dev.5
 platform: ruby
 authors:
 - Robert Gauld
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-25 00:00:00.000000000 Z
+date: 2015-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport