osm 0.6.3 → 1.0.0

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## Version 1.0.0
+
+  * SMS text messages:
+    * Section gains sms\_sent\_test, sms\_messages\_sent and sms\_messages\_remaining attributes
+    * Add Sms class:
+      * With send\_sms(api, section\_id, member\_ids, all\_or\_one, source\_address, message) method
+      * With DeliveryReport Model subclass
+        * With get\_for\_section(api, section) class method
+
 ## Version 0.6.3
 
   * Fix started? and started methods for badges with a combination of custom and normal requirements

data/README.md

@@ -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.6.0'
+gem 'osm', '~> 1.0.0'
 ```
 
 Configure the gem during the initalization of the app (e.g. if using rails then config/initializers/osm.rb would look like):
@@ -108,6 +108,7 @@ however it should be noted that when the OSM API adds a feature it can be diffic
   * Roles
   * Section
   * Sections
+  * SMS Delivery Reports
   * Term
   * Terms
 
@@ -141,15 +142,13 @@ however it should be noted that when the OSM API adds a feature it can be diffic
 ### Actions
   * Authorise an app to use the API on a user's behalf
   * Add activity to programme
+  * Send an SMS to member(s)
 
 
 ## Parts of the OSM API currently NOT supported (may not be an exhaustive list):
 
 See the [Roadmap page in the wiki](https://github.com/robertgauld/osm/wiki/Roadmap) for more details.
 
-  * SMS:
-    * Retrieval of delivery reports [issue 54]
-    * Sending a message [issue 54]
-  * Gift aid (Everything) (Gold required)
-  * Finances (Everything) (Gold required)
+  * Gift aid (Everything) (Gold required) [issue 75]
+  * Finances (Everything) (Gold required) [issues 76 & 77]]
   * MyScout (Everything) (Maybe)

data/lib/osm.rb

@@ -91,7 +91,7 @@ module Osm
     end
   end
 
-  def self.parse_date_time(date_time)
+  def self.parse_datetime(date_time)
     return nil if date_time.nil? || date_time.empty?
     begin
       return DateTime.strptime((date_time), OSM_DATETIME_FORMAT)

data/lib/osm/section.rb

@@ -61,6 +61,12 @@ 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] 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
@@ -92,6 +98,9 @@ module Osm
     attribute :myscout_event_reminder_frequency, :type => Integer
     attribute :myscout_payment_reminder_count, :type => Integer
     attribute :myscout_payment_reminder_frequency, :type => Integer
+    attribute :sms_sent_test, :type => Boolean, :default => false
+    attribute :sms_messages_sent, :type => Integer, :default => 0
+    attribute :sms_messages_remaining, :type => Integer, :default => 0
 
     attr_accessible :id, :name, :group_id, :group_name, :subscription_level, :subscription_expires,
                     :type, :column_names, :fields, :intouch_fields, :mobile_fields, :flexi_records,
@@ -101,7 +110,8 @@ module Osm
                     :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_payment_reminder_count, :myscout_payment_reminder_frequency,
+                    :sms_sent_test, :sms_messages_sent, :sms_messages_remaining
 
     validates_numericality_of :id, :only_integer=>true, :greater_than=>0, :allow_nil => true
     validates_numericality_of :group_id, :only_integer=>true, :greater_than=>0, :allow_nil => true
@@ -109,6 +119,8 @@ 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
@@ -130,6 +142,7 @@ module Osm
     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 :sms_sent_test, :in => [true, false]
 
     validates :column_names, :hash => {:key_type => Symbol, :value_type => String}
     validates :fields, :hash => {:key_type => Symbol, :value_in => [true, false]}
@@ -216,6 +229,9 @@ module Osm
             :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,
+            :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

@@ -0,0 +1,180 @@
+module Osm
+
+  class Sms
+
+    # Get delivery reports
+    # @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 [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)
+
+      data = api.perform_query("sms.php?action=sendText&sectionid=#{section.to_i}", {
+        'msg' => message,
+        'scouts' => [*members].join(','),
+        'source' => source_address,
+        'all' => all_or_one,
+        'scheduled' => 'now',
+      })
+
+      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]
+      end
+      return Hash[*data.flatten]
+    end
+
+
+
+    class DeliveryReport < Osm::Model
+      # @!attribute [rw] sms_id
+      #   @return [Fixnum] the id of the SMS
+      # @!attribute [rw] user_id
+      #   @return [Fixnum] the id of the OSM user who sent the SMS
+      # @!attribute [rw] member_id
+      #   @return [Fixnum] the id of the member the SMS was sent to
+      # @!attribute [rw] section_id
+      #   @return [Fixnum] the id of the section 'owning' the SMS
+      # @!attribute [rw] from_name
+      #   @return [String] the name of the person who sent the SMS
+      # @!attribute [rw] from_number
+      #   @return [String] the number the SMS was 'sent from'
+      # @!attribute [rw] to_name
+      #   @return [String] the name of the person the message was sent to
+      # @!attribute [rw] to_number
+      #   @return [String] the number the SMS was sent to
+      # @!attribute [rw] message
+      #   @return [String] the text of the SMS
+      # @!attribute [rw] scheduled
+      #   @return [DateTime] when the SMS was scheduled to be sent
+      # @!attribute [rw] last_updated
+      #   @return [DateTime] when this report was last updated
+      # @!attribute [rw] credits
+      #   @return [Fixnum] thow many credits the SMS cost
+      # @!attribute [rw] status
+      #   @return [Symbol] the status of the SMS (usually :sent, :delivered, :not_delivered, :invalid_destination_address or :not_sent)
+
+      attribute :sms_id, :type => Integer
+      attribute :user_id, :type => Integer
+      attribute :member_id, :type => Integer
+      attribute :section_id, :type => Integer
+      attribute :from_name, :type => String
+      attribute :from_number, :type => String
+      attribute :to_name, :type => String
+      attribute :to_number, :type => String
+      attribute :message, :type => String
+      attribute :scheduled, :type => DateTime
+      attribute :last_updated, :type => DateTime
+      attribute :credits, :type => Integer
+      attribute :status, :type => Object
+
+      attr_accessible :sms_id, :user_id, :member_id, :section_id, :from_name, :from_number, :to_name, :to_number, :message, :scheduled, :last_updated, :credits, :status
+
+      validates_numericality_of :sms_id, :only_integer=>true, :greater_than_or_equal_to=>0
+      validates_numericality_of :user_id, :only_integer=>true, :greater_than_or_equal_to=>0
+      validates_numericality_of :member_id, :only_integer=>true, :greater_than_or_equal_to=>0
+      validates_numericality_of :section_id, :only_integer=>true, :greater_than_or_equal_to=>0
+      validates_numericality_of :credits, :only_integer=>true, :greater_than_or_equal_to=>0
+      validates_presence_of :from_name
+      validates_presence_of :from_number
+      validates_presence_of :to_name
+      validates_presence_of :to_number
+      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
+
+
+      # @!method initialize
+      #   Initialize a new Badge
+      #   @param [Hash] attributes The hash of attributes (see attributes for descriptions, use Symbol of attribute name as the key)
+
+
+      # Get delivery reports
+      # @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 reports for
+      # @!macro options_get
+      # @return [Array<Osm::Sms::DeliveryReport>]
+      def self.get_for_section(api, section, options={})
+        require_access_to_section(api, section, options)
+        section_id = section.to_i
+        cache_key = ['sms_delivery_reports', section_id]
+
+        if !options[:no_cache] && Osm::Model.cache_exist?(api, cache_key)
+          return cache_read(api, cache_key)
+        end
+
+        reports = []
+        get_name_number_regex = /\A(?<name>.*\w)\W+(?<number>\d*)\Z/
+        data = api.perform_query("sms.php?action=deliveryReports&sectionid=#{section_id}&dateFormat=generic")
+        data['items'].each do |report|
+          from = report['from'].match(get_name_number_regex)
+          to = report['to'].match(get_name_number_regex)
+          reports.push new(
+            :sms_id => Osm.to_i_or_nil(report['smsid']),
+            :user_id => Osm.to_i_or_nil(report['userid']),
+            :member_id => Osm.to_i_or_nil(report['scoutid']),
+            :section_id => Osm.to_i_or_nil(report['sectionid']),
+            :from_name => from[:name],
+            :from_number => "+#{from[:number]}",
+            :to_name => to[:name],
+            :to_number => "+#{to[:number]}",
+            :message => report['message'],
+            :scheduled => Osm.parse_datetime(report['schedule']),
+            :last_updated => Osm.parse_datetime(report['lastupdated']),
+            :credits => Osm.to_i_or_nil(report['credits']),
+            :status => (report['status'] || 'error').downcase.to_sym,
+          )
+        end
+
+        cache_write(api, cache_key, reports)
+        return reports
+      end
+
+
+      # @!method status_sent?
+      #   Check if the SMS was sent
+      #   @return (Boolean)
+      # @!method status_not_sent?
+      #   Check if the SMS was not sent
+      #   @return (Boolean)
+      # @!method status_delivered?
+      #   Check if the SMS was delivered
+      #   @return (Boolean)
+      # @!method status_not_delivered?
+      #   Check if the SMS was not delivered
+      #   @return (Boolean)
+      # @!method status_invalid_destination_address?
+      #   Check if the SMS had an invalid destination address
+      #   @return (Boolean)
+      # @!method status_invalid_source_address?
+      #   Check if the SMS had an invalid source address
+      #   @return (Boolean)
+      # @!method status_invalid_message_format?
+      #   Check if the SMS message was in an invalid format
+      #   @return (Boolean)
+      # @!method route_not_available?
+      #   Check if the SMS sending service could not route the message
+      #   @return (Boolean)
+      # @!method status_not_allowed?
+      #   Check if the SMS sending service refused to send the message
+      #   @return (Boolean)
+      VALID_STATUSES.each do |attribute|
+        define_method "status_#{attribute}?" do
+          status == attribute
+        end
+      end
+
+    end
+
+  end
+
+end

data/spec/osm/section_spec.rb

@@ -37,7 +37,10 @@ describe "Section" do
       :myscout_event_reminder_count => 4,
       :myscout_event_reminder_frequency => 5,
       :myscout_payment_reminder_count => 6,
-      :myscout_payment_reminder_frequency => 7
+      :myscout_payment_reminder_frequency => 7,
+      :sms_sent_test => true,
+      :sms_messages_sent => 8,
+      :sms_messages_remaining => 9,
     }
   end
 
@@ -75,6 +78,9 @@ describe "Section" do
     section.myscout_event_reminder_frequency.should == 5
     section.myscout_payment_reminder_count.should == 6
     section.myscout_payment_reminder_frequency.should == 7
+    section.sms_sent_test.should == true
+    section.sms_messages_sent.should == 8
+    section.sms_messages_remaining.should == 9
     section.valid?.should be_true
   end
 
@@ -92,6 +98,9 @@ describe "Section" do
     section.flexi_records.should == []
     section.myscout_email_address_from.should == ''
     section.myscout_email_address_copy.should == ''
+    section.sms_sent_test.should == false
+    section.sms_messages_sent.should == 0
+    section.sms_messages_remaining.should == 0
   end
 
 
@@ -99,8 +108,8 @@ describe "Section" do
 
     before :each do
       body = [
-        {"sectionConfig"=>"{\"subscription_level\":1,\"subscription_expires\":\"2013-01-05\",\"sectionType\":\"beavers\",\"columnNames\":{\"column_names\":\"names\"},\"numscouts\":10,\"hasUsedBadgeRecords\":true,\"hasProgramme\":true,\"extraRecords\":[{\"name\":\"Flexi Record 1\",\"extraid\":\"111\"}],\"wizard\":\"false\",\"fields\":{\"fields\":true},\"intouch\":{\"intouch_fields\":true},\"mobFields\":{\"mobile_fields\":true},\"gocardless\":\"true\",\"portal\":{\"paymentRemindFrequency\":\"7\",\"paymentRemindCount\":\"6\",\"eventRemindFrequency\":\"5\",\"eventRemindCount\":\"4\",\"badgesPartial\":1,\"programmeTimes\":1,\"programmeSummary\":1,\"emailAddress\":\"send_from@example.com\",\"emailAddressCopy\":null,\"payments\":1,\"badges\":1,\"emails\":{\"email1\":\"true\",\"email2\":\"false\"},\"events\":1,\"programme\":1},\"portalExpires\":{\"events\":\"2013-01-06\",\"eventsA\":1,\"badges\":\"2013-01-07\",\"badgesA\":1,\"programme\":\"2013-01-08\",\"programmeA\":1}}", "groupname"=>"3rd Somewhere", "groupid"=>"3", "groupNormalised"=>"1", "sectionid"=>"1", "sectionname"=>"Section 1", "section"=>"beavers", "isDefault"=>"1", "permissions"=>{"badge"=>10, "member"=>20, "user"=>100, "register"=>100, "contact"=>100, "programme"=>100, "originator"=>1, "events"=>100, "finance"=>100, "flexi"=>100}},
-        {"sectionConfig"=>"{\"subscription_level\":3,\"subscription_expires\":\"2013-01-05\",\"sectionType\":\"cubs\",\"columnNames\":{\"phone1\":\"Home Phone\",\"phone2\":\"Parent 1 Phone\",\"address\":\"Member's Address\",\"phone3\":\"Parent 2 Phone\",\"address2\":\"Address 2\",\"phone4\":\"Alternate Contact Phone\",\"subs\":\"Gender\",\"email1\":\"Parent 1 Email\",\"medical\":\"Medical / Dietary\",\"email2\":\"Parent 2 Email\",\"ethnicity\":\"Gift Aid\",\"email3\":\"Member's Email\",\"religion\":\"Religion\",\"email4\":\"Email 4\",\"school\":\"School\"},\"numscouts\":10,\"hasUsedBadgeRecords\":true,\"hasProgramme\":true,\"extraRecords\":[],\"wizard\":\"false\",\"fields\":{\"email1\":true,\"email2\":true,\"email3\":true,\"email4\":false,\"address\":true,\"address2\":false,\"phone1\":true,\"phone2\":true,\"phone3\":true,\"phone4\":true,\"school\":false,\"religion\":true,\"ethnicity\":true,\"medical\":true,\"patrol\":true,\"subs\":true,\"saved\":true},\"intouch\":{\"address\":true,\"address2\":false,\"email1\":false,\"email2\":false,\"email3\":false,\"email4\":false,\"phone1\":true,\"phone2\":true,\"phone3\":true,\"phone4\":true,\"medical\":false},\"mobFields\":{\"email1\":false,\"email2\":false,\"email3\":false,\"email4\":false,\"address\":true,\"address2\":false,\"phone1\":true,\"phone2\":true,\"phone3\":true,\"phone4\":true,\"school\":false,\"religion\":false,\"ethnicity\":true,\"medical\":true,\"patrol\":true,\"subs\":false}}", "groupname"=>"1st Somewhere", "groupid"=>"1", "groupNormalised"=>"1", "sectionid"=>"2", "sectionname"=>"Section 2", "section"=>"cubs", "isDefault"=>"0", "permissions"=>{"badge"=>100, "member"=>100, "user"=>100, "register"=>100, "contact"=>100, "programme"=>100, "originator"=>1, "events"=>100, "finance"=>100, "flexi"=>100}}
+        {"sectionConfig"=>"{\"subscription_level\":1,\"subscription_expires\":\"2013-01-05\",\"sectionType\":\"beavers\",\"columnNames\":{\"column_names\":\"names\"},\"numscouts\":10,\"hasUsedBadgeRecords\":true,\"hasProgramme\":true,\"extraRecords\":[{\"name\":\"Flexi Record 1\",\"extraid\":\"111\"}],\"wizard\":\"false\",\"fields\":{\"fields\":true},\"intouch\":{\"intouch_fields\":true},\"mobFields\":{\"mobile_fields\":true},\"gocardless\":\"true\",\"portal\":{\"paymentRemindFrequency\":\"7\",\"paymentRemindCount\":\"6\",\"eventRemindFrequency\":\"5\",\"eventRemindCount\":\"4\",\"badgesPartial\":1,\"programmeTimes\":1,\"programmeSummary\":1,\"emailAddress\":\"send_from@example.com\",\"emailAddressCopy\":null,\"payments\":1,\"badges\":1,\"emails\":{\"email1\":\"true\",\"email2\":\"false\"},\"events\":1,\"programme\":1},\"portalExpires\":{\"events\":\"2013-01-06\",\"eventsA\":1,\"badges\":\"2013-01-07\",\"badgesA\":1,\"programme\":\"2013-01-08\",\"programmeA\":1},\"hasSentTestSMS\":true,\"sms_remaining\":8,\"sms_sent\":9}", "groupname"=>"3rd Somewhere", "groupid"=>"3", "groupNormalised"=>"1", "sectionid"=>"1", "sectionname"=>"Section 1", "section"=>"beavers", "isDefault"=>"1", "permissions"=>{"badge"=>10, "member"=>20, "user"=>100, "register"=>100, "contact"=>100, "programme"=>100, "originator"=>1, "events"=>100, "finance"=>100, "flexi"=>100}},
+        {"sectionConfig"=>"{\"subscription_level\":3,\"subscription_expires\":\"2013-01-05\",\"sectionType\":\"cubs\",\"columnNames\":{\"phone1\":\"Home Phone\",\"phone2\":\"Parent 1 Phone\",\"address\":\"Member's Address\",\"phone3\":\"Parent 2 Phone\",\"address2\":\"Address 2\",\"phone4\":\"Alternate Contact Phone\",\"subs\":\"Gender\",\"email1\":\"Parent 1 Email\",\"medical\":\"Medical / Dietary\",\"email2\":\"Parent 2 Email\",\"ethnicity\":\"Gift Aid\",\"email3\":\"Member's Email\",\"religion\":\"Religion\",\"email4\":\"Email 4\",\"school\":\"School\"},\"numscouts\":10,\"hasUsedBadgeRecords\":true,\"hasProgramme\":true,\"extraRecords\":[],\"wizard\":\"false\",\"fields\":{\"email1\":true,\"email2\":true,\"email3\":true,\"email4\":false,\"address\":true,\"address2\":false,\"phone1\":true,\"phone2\":true,\"phone3\":true,\"phone4\":true,\"school\":false,\"religion\":true,\"ethnicity\":true,\"medical\":true,\"patrol\":true,\"subs\":true,\"saved\":true},\"intouch\":{\"address\":true,\"address2\":false,\"email1\":false,\"email2\":false,\"email3\":false,\"email4\":false,\"phone1\":true,\"phone2\":true,\"phone3\":true,\"phone4\":true,\"medical\":false},\"mobFields\":{\"email1\":false,\"email2\":false,\"email3\":false,\"email4\":false,\"address\":true,\"address2\":false,\"phone1\":true,\"phone2\":true,\"phone3\":true,\"phone4\":true,\"school\":false,\"religion\":false,\"ethnicity\":true,\"medical\":true,\"patrol\":true,\"subs\":false},\"hasSentTestSMS\":true,\"sms_remaining\":8,\"sms_sent\":9}", "groupname"=>"1st Somewhere", "groupid"=>"1", "groupNormalised"=>"1", "sectionid"=>"2", "sectionname"=>"Section 2", "section"=>"cubs", "isDefault"=>"0", "permissions"=>{"badge"=>100, "member"=>100, "user"=>100, "register"=>100, "contact"=>100, "programme"=>100, "originator"=>1, "events"=>100, "finance"=>100, "flexi"=>100}}
       ]
       FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/api.php?action=getUserRoles", :body => body.to_json)
     end
@@ -143,6 +152,9 @@ describe "Section" do
         section.myscout_event_reminder_frequency.should == 5
         section.myscout_payment_reminder_count.should == 6
         section.myscout_payment_reminder_frequency.should == 7
+        section.sms_sent_test.should == true
+        section.sms_messages_remaining.should == 8
+        section.sms_messages_sent.should == 9
       end
 
       it "From cache" do

data/spec/osm/sms_spec.rb

@@ -0,0 +1,129 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe "SMS" do
+
+  describe "Send an SMS" do
+
+    it "Success" 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',
+        'all' => :one,
+        'scheduled' => 'now',
+      }}) { OsmTest::DummyHttpResult.new(:response=>{:code=>'200', :body=>{'result'=>true,'sent'=>2,'message'=>'Success','debug'=>nil,'config'=>{}}.to_json}) }
+
+      result = Osm::Sms.send_sms(
+        @api,
+        1,      # Section
+        [2, 3], # Members
+        :one,
+        '441234567890', # Source address
+        'Test message.' # Message text
+      )
+
+      result.should == {
+        :result => true,
+        :sent => 2,
+        :message => 'Success'
+      }
+    end
+
+  end
+
+
+  describe "Delivery Report" do
+
+    it "Create" do
+      report = Osm::Sms::DeliveryReport.new(
+        :sms_id => 1,
+        :user_id => 2,
+        :member_id => 3,
+        :section_id => 4,
+        :from_name => 'a',
+        :from_number => '5',
+        :to_name => 'b',
+        :to_number => '6',
+        :message => 'c',
+        :scheduled => DateTime.new(2000, 1, 2, 3, 4, 5),
+        :last_updated => DateTime.new(2000, 1, 2, 3, 5, 6),
+        :credits => 7,
+        :status => :delivered,
+      )
+
+      report.sms_id.should == 1
+      report.user_id.should == 2
+      report.member_id.should == 3
+      report.section_id.should == 4
+      report.from_name.should == 'a'
+      report.from_number.should == '5'
+      report.to_name.should == 'b'
+      report.to_number.should == '6'
+      report.message.should == 'c'
+      report.scheduled.should == DateTime.new(2000, 1, 2, 3, 4, 5)
+      report.last_updated.should == DateTime.new(2000, 1, 2, 3, 5, 6)
+      report.credits.should == 7
+      report.status.should == :delivered
+      report.valid?.should be_true
+    end
+
+    describe "Status helpers" do
+      statuses = Osm::Sms::DeliveryReport::VALID_STATUSES
+      statuses.each do |status|
+        it "For #{status}" do
+          statuses.each do |test_status|
+            Osm::Sms::DeliveryReport.new(:status => status).send("status_#{test_status}?").should == (status == test_status)
+          end
+        end
+      end
+    end
+
+    it "Get from OSM" do
+      data = {
+        "identifier" => "smsid",
+        "items" => [{
+          "smsid" => "2",
+          "userid" => "3",
+          "scoutid" => "4",
+          "sectionid" => "1",
+          "phone" => "442345678901",
+          "from" => "From Name  443456789012",
+          "message" => "Test message.",
+          "schedule" => "2000-01-02 03:04:05",
+          "status" => "DELIVERED",
+          "lastupdated" => "2000-01-02 03:04:06",
+          "credits" => "1",
+          "fromuser" => "From Name ",
+          "firstname" => "To",
+          "lastname" => "Name",
+          "to" => "To Name 441234567890"
+        }]
+      }
+      FakeWeb.register_uri(:post, "https://www.onlinescoutmanager.co.uk/sms.php?action=deliveryReports&sectionid=1&dateFormat=generic", :body => data.to_json)
+
+      reports = Osm::Sms::DeliveryReport.get_for_section(@api, 1)
+      reports.size.should == 1
+      report = reports[0]
+      report.sms_id.should == 2
+      report.user_id.should == 3
+      report.member_id.should == 4
+      report.section_id.should == 1
+      report.from_name.should == 'From Name'
+      report.from_number.should == '+443456789012'
+      report.to_name.should == 'To Name'
+      report.to_number.should == '+441234567890'
+      report.message.should == 'Test message.'
+      report.scheduled.should == DateTime.new(2000, 1, 2, 3, 4, 5)
+      report.last_updated.should == DateTime.new(2000, 1, 2, 3, 4, 6)
+      report.credits.should == 1
+      report.status.should == :delivered
+    end
+
+  end
+
+end

data/version.rb

@@ -1,3 +1,3 @@
 module Osm
-  VERSION = "0.6.3"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: osm
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -204,6 +204,7 @@ files:
 - lib/osm/model.rb
 - lib/osm/register.rb
 - lib/osm/section.rb
+- lib/osm/sms.rb
 - lib/osm/term.rb
 - osm.gemspec
 - spec/osm/activity_spec.rb
@@ -220,6 +221,7 @@ files:
 - spec/osm/osm_spec.rb
 - spec/osm/register_spec.rb
 - spec/osm/section_spec.rb
+- spec/osm/sms_spec.rb
 - spec/osm/term_spec.rb
 - spec/spec_helper.rb
 - version.rb