mblox 0.0.2 → 0.0.3

data/.rspec

@@ -0,0 +1 @@
+--color

data/README.md

@@ -33,17 +33,21 @@ Configuration
       # You can also configure some logging options
       # In a Rails environment, config.logger will default to Rails.logger and config.log_at will default to :debug
       # config.log_at means the level at which Mblox will log.
-      # If config.log_at == :debug and your logger's log level is :info, logging will be suppressed because it is below the log level of the logger.
+      # For instance, if config.log_at == :debug, Mblox will log only if the logger's log level is :debug
+      # Note that if config.log_at == :debug and your logger's log level is :info,
+      #   logging will be suppressed because it is below the log level of the logger.
       config.logger = Logger.new(STDOUT)
       config.log_at :info
       
       # What to do if messages are longer than 160 characters.  Default is :raise_error
+      # Other options are :truncate and :split
       config.on_message_too_long = :truncate
     end
 
 Once your application is configured, send messages:
 
-    phone_number = 2225555555 # The number you're sending to.  Must be a 10-digit number, including the area code.  Can be a String or Fixnum.
+    # The number to sending to must be a 10-digit number, including the area code.  Can be a String or Fixnum.
+    phone_number = 2225555555 # or: phone_number = "2225555555"
     Mblox::Sms.new(phone_number, "your message").send
 
 ## Testing

data/lib/mblox/configuration.rb

@@ -19,7 +19,7 @@ module Mblox
     end
 
     def on_message_too_long= action
-      raise ArgumentError, "Mblox.config.on_message_too_long must be either :truncate or :raise_error" unless [:truncate, :raise_error].include?(action)
+      raise ArgumentError, "Mblox.config.on_message_too_long must be either :truncate, :split or :raise_error" unless [:truncate, :raise_error, :split].include?(action)
       @on_message_too_long = action
     end
 

data/lib/mblox/sms.rb

@@ -5,22 +5,29 @@ require "net/https"
 
 module Mblox
   class Sms
+    MAX_LENGTH = 160
+    MAX_SECTION_LENGTH = MAX_LENGTH - "(MSG XXX/XXX): ".size
+
     attr_reader :phone, :message
+
+    ON_MESSAGE_TOO_LONG_HANDLER = {
+      :raise_error => Proc.new { raise SmsError, "Message cannot be longer than #{MAX_LENGTH} characters" },
+      :truncate => Proc.new { |message| Mblox.log "Truncating message due to length.  Message was: \"#{message}\" but will now be \"#{message = message[0,MAX_LENGTH]}\""; [message] },
+      :split => Proc.new { |message| split_message(message) }
+    }
+
     def initialize(phone,message)
       phone = phone.to_s
       raise SmsError, "Phone number must be ten digits" unless /\A[0-9]{10}\z/.match(phone)
       raise SmsError, "Phone number cannot begin with 0 or 1" if ['0','1'].include?(phone[0].to_s)
       raise SmsError, "Message cannot be blank" if message.empty?
-      if message.size > 160
-        raise SmsError, "Message cannot be longer than 160 characters" if :raise_error == Mblox.config.on_message_too_long
-        message = message[0,160] if :truncate == Mblox.config.on_message_too_long
-      end
+      Mblox.log "WARNING: Some characters may be lost because the message must be broken into at least 1000 sections" if message.size > (999 * MAX_SECTION_LENGTH)
+      @message = (message.size > MAX_LENGTH) ? ON_MESSAGE_TOO_LONG_HANDLER[Mblox.config.on_message_too_long].call(message) : [message.dup]
       @phone = "1#{phone}"
-      @message = message.dup
     end
 
     def send
-      commit build
+      @message.collect { |message| commit build(message) }
     end
     private
       def commit(request_body)
@@ -43,7 +50,7 @@ module Mblox
 	"RequestResult: \"#{result_header['RequestResultCode']}:#{result_header['RequestResultText']}\" / SubscriberResult: \"#{subscriber_result['SubscriberResultCode']}:#{subscriber_result['SubscriberResultText']}\""
       end
 
-      def build
+      def build(message)
 	builder = Builder::XmlMarkup.new
 	builder.instruct!(:xml, :encoding => "ISO-8859-1")
 	builder.NotificationRequest(:Version => "3.5") do |nr|
@@ -53,7 +60,7 @@ module Mblox
 	  end
 	  nr.NotificationList(:BatchID => "1") do |nl|
 	    nl.Notification(:SequenceNumber => "1", :MessageType => "SMS") do |n|
-	      n.Message(@message)
+	      n.Message(message)
 	      n.Profile(Mblox.config.profile_id)
 	      n.SenderID(Mblox.config.sender_id, :Type => 'Shortcode')
 	      n.Tariff(Mblox.config.tariff)
@@ -65,5 +72,23 @@ module Mblox
 	  end
 	end
       end
+
+      def self.section_counter(size)
+        size / MAX_SECTION_LENGTH + ((size % MAX_SECTION_LENGTH).zero? ? 0 : 1)
+      end
+
+      def self.split_message(message)
+        sections = section_counter(message.size)
+        Mblox.log "Splitting message into #{sections} messages due to length."
+        split_message = []
+        (sections - 1).times do |i|
+          first_char = i * MAX_SECTION_LENGTH
+          Mblox.log "Section ##{i + 1} of ##{sections} contains characters #{first_char + 1} thru #{first_char + MAX_SECTION_LENGTH} of #{message.size}"
+          split_message << "(MSG #{i+1}/#{sections}): #{message[first_char, MAX_SECTION_LENGTH]}"
+        end
+        first_char = (sections-1)*MAX_SECTION_LENGTH
+        Mblox.log "Section ##{sections} of ##{sections} contains characters #{first_char + 1} thru #{message.size} of #{message.size}"
+        split_message << "(MSG #{sections}/#{sections}): #{message[first_char..-1]}"
+      end
   end
 end

data/lib/mblox/version.rb

@@ -1,3 +1,3 @@
 module Mblox
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/configuration_spec.rb

@@ -11,12 +11,16 @@ describe "configuration" do
       expect { Mblox.config.on_message_too_long = :truncate }.to_not raise_error
     end
 
+    it "should allow the value :split" do
+      expect { Mblox.config.on_message_too_long = :split }.to_not raise_error
+    end
+
     it "should allow the value :raise_error" do
       expect { Mblox.config.on_message_too_long = :raise_error }.to_not raise_error
     end
 
     it "should not allow other values and should remain in a valid state" do
-      expect { Mblox.config.on_message_too_long = :do_nothing }.to raise_error(ArgumentError, "Mblox.config.on_message_too_long must be either :truncate or :raise_error")
+      expect { Mblox.config.on_message_too_long = :do_nothing }.to raise_error(ArgumentError, "Mblox.config.on_message_too_long must be either :truncate, :split or :raise_error")
       expect(Mblox.config.on_message_too_long).to eq(:raise_error)
     end
   end

data/spec/sms_spec.rb

@@ -33,7 +33,7 @@ describe "message" do
     message = "A"+"ABCDEFGHIJ"*16
     Mblox.config.on_message_too_long = :truncate
     expect { @mblox = Mblox::Sms.new("2"*10, message) }.to_not raise_error
-    expect(@mblox.message).to eq(message[0,160])
+    expect(@mblox.message).to eq([message[0,160]])
   end
 
   it "cannot be longer than 160 characters if configured to raise error" do
@@ -41,28 +41,51 @@ describe "message" do
     expect { Mblox::Sms.new("2"*10, "A"*161) }.to raise_error(Mblox::SmsError, "Message cannot be longer than 160 characters")
   end
 
-  it "should be safe from changing" do
+  it "should be split into multiple messages when longer than 160 characters if configured to split and even split" do
+    message = "ABCDEFGHIJ"*58
+    Mblox.config.on_message_too_long = :split
+    expect { @mblox = Mblox::Sms.new("2"*10, message) }.to_not raise_error
+    expect(@mblox.message).to eq(["(MSG 1/4): #{message[0,145]}", "(MSG 2/4): #{message[145,145]}", "(MSG 3/4): #{message[290,145]}", "(MSG 4/4): #{message[435,145]}"])
+    expect(@mblox.send).to eq(Array.new(4, result_unroutable))
+  end
+
+  it "should be split into multiple messages when longer than 160 characters if configured to split and not even split" do
+    message = "ABCDEFGHIJ"*32
+    Mblox.config.on_message_too_long = :split
+    expect { @mblox = Mblox::Sms.new("2"*10, message) }.to_not raise_error
+    expect(@mblox.message).to eq(["(MSG 1/3): #{message[0,145]}", "(MSG 2/3): #{message[145,145]}", "(MSG 3/3): #{message[290..-1]}"])
+    expect(@mblox.send).to eq(Array.new(3, result_unroutable))
+  end
+
+  it "should be safe from changing when short" do
     msg = the_message
     mblox = Mblox::Sms.new(TEST_NUMBER,msg)
     msg[1..3] = ''
-    expect(mblox.message).to eq(the_message)
+    expect(mblox.message).to eq([the_message])
+  end
+
+  it "should be safe from changing when long" do
+    msg = the_message * 10
+    mblox = Mblox::Sms.new(TEST_NUMBER,msg)
+    msg[1..3] = ''
+    expect(mblox.message[0][11, 20]).to eq(the_message[0,20])
   end
 end
 
 describe "SMS messages" do
   it "should be sent when the phone number is a Fixnum" do
-    expect(Mblox::Sms.new(TEST_NUMBER.to_i,the_message).send).to eq(result_ok)
+    expect(Mblox::Sms.new(TEST_NUMBER.to_i,the_message).send).to eq([result_ok])
   end
 
   it "should be sent when the phone number is a String" do
-    expect(Mblox::Sms.new(TEST_NUMBER.to_s,the_message).send).to eq(result_ok)
+    expect(Mblox::Sms.new(TEST_NUMBER.to_s,the_message).send).to eq([result_ok])
   end
 
   it "should allow 160-character messages" do
-    expect(Mblox::Sms.new(TEST_NUMBER,"A"*160).send).to eq(result_ok)
+    expect(Mblox::Sms.new(TEST_NUMBER,"A"*160).send).to eq([result_ok])
   end
 
   it "should fail when sent to a landline" do
-    expect(Mblox::Sms.new("6176354500",the_message).send).to eq(result_unroutable)
+    expect(Mblox::Sms.new("6176354500",the_message).send).to eq([result_unroutable])
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mblox
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-01 00:00:00.000000000 Z
+date: 2013-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -115,6 +115,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -143,12 +144,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 965711471
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 965711471
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -162,18 +169,21 @@ summary: ! '# Mblox  This gem is for subscribers to Mblox to send SMS messages.
   = ... config.partner_name = ... config.tariff = ... config.service_id = ...  # You
   can also configure some logging options # In a Rails environment, config.logger
   will default to Rails.logger and config.log_at will default to :debug # config.log_at
-  means the level at which Mblox will log. # If config.log_at == :debug and your logger''s
-  log level is :info, logging will be suppressed because it is below the log level
-  of the logger. config.logger = Logger.new(STDOUT) config.log_at :info  # What to
-  do if messages are longer than 160 characters.  Default is :raise_error config.on_message_too_long
-  = :truncate end  Once your application is configured, send messages:  phone_number
-  = 2225555555 # The number you''re sending to.  Must be a 10-digit number, including
-  the area code.  Can be a String or Fixnum. Mblox::Sms.new(phone_number, "your message").send  ##
-  Testing  Copy config.yml.example to config.yml and set all the values in that file.  Run:  rspec  You
-  should recieve 3 SMS messages to your phone within several seconds.  ## Contributing  1.
-  Fork it 2. Create your feature branch (`git checkout -b my-new-feature`) 3. Commit
-  your changes (`git commit -am ''Add some feature''`) 4. Push to the branch (`git
-  push origin my-new-feature`) 5. Create new Pull Request'
+  means the level at which Mblox will log. # For instance, if config.log_at == :debug,
+  Mblox will log only if the logger''s log level is :debug # Note that if config.log_at
+  == :debug and your logger''s log level is :info, #   logging will be suppressed
+  because it is below the log level of the logger. config.logger = Logger.new(STDOUT)
+  config.log_at :info  # What to do if messages are longer than 160 characters.  Default
+  is :raise_error # Other options are :truncate and :split config.on_message_too_long
+  = :truncate end  Once your application is configured, send messages:  # The number
+  to sending to must be a 10-digit number, including the area code.  Can be a String
+  or Fixnum. phone_number = 2225555555 # or: phone_number = "2225555555" Mblox::Sms.new(phone_number,
+  "your message").send  ## Testing  Copy config.yml.example to config.yml and set
+  all the values in that file.  Run:  rspec  You should recieve 3 SMS messages to
+  your phone within several seconds.  ## Contributing  1. Fork it 2. Create your feature
+  branch (`git checkout -b my-new-feature`) 3. Commit your changes (`git commit -am
+  ''Add some feature''`) 4. Push to the branch (`git push origin my-new-feature`)
+  5. Create new Pull Request'
 test_files:
 - spec/configuration_spec.rb
 - spec/log_spec.rb