mblox 0.2.2 → 0.2.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OWEwYTcwMzU3ODdiNGNhOWQ3MmUxODcwMDMxMjU0ZjNlM2FlNTA1MA==
+    NjNlOGM0NDk1MjU5MzEzZWVkMTAwYmM2ZjhiZDlmOTk4Y2I3ZGQyZA==
   data.tar.gz: !binary |-
-    YzhjMDQ3MWI2Zjk0YTJjMjg2MGQ2ZWUyMGU4MDlkZTY2ODg4YzI1Yg==
+    ZjA3YzY2MGM5ZjhiNGY1NjNmNDVmODliNDIwNmZhNzI3ZjRhYTE0Zg==
 SHA512:
   metadata.gz: !binary |-
-    MDU5YTVhMmNkOGY4ZWFjMTZjMTQxNTdjNzNjNDgxNWFkNTM2ZGMyZjI1ODNl
-    ZWMwMzJmZmNiNzY2NmFmZTIyZmQxNzMxMDY1Mzg2NDFlODBmYTNmYjg5YzRk
-    NDNlNmU4ZjEzZjcwNWU1MDdiZGIxZmM1YmRmZDNiYWQ2OTFkNGI=
+    OGNiMDI2ZTExZWM0MzFiN2VlMzQ1YWQ1MzQwZDlmZWIxMmNmNDg4YWIxNGJm
+    MWNlZGNiMDc0OTJjYjZjMDQyNjU2M2NhYzQ4NjA4YWI0MDVmNGE0MzRjZjRl
+    ODAxOTVhMTE0ODQzZmQ5YmY2NGJjNTFmYTcwNzBjOTc4YjYxOWE=
   data.tar.gz: !binary |-
-    OGEwZDk5NDQ0ODk2MjI5M2UxZDA0MGJjZjg2YzE1MDE1MDAzMTU5NmQ0ODU0
-    MTJmMmQ1NmY2NGIwMzA2NDAyOWVlMzVjNWVlNzczNTkxZjVmYmQwOWVkOWEz
-    NjBlMjQwNWM1MGRhZjI1M2ZiNmExZWYzOGIzNWRjNmViOTVkNzc=
+    NDA1ZTAwNGE1NDNjNmNjZmExYmI0NWVkOWY2NGE2MThlMjM3NjU0MjJhNGMz
+    YjkyZmI1ZjBiZGRiMzhhYmVlYmJmMjMzYTg3ODQ1YmJlOTkxYWM4YjU5YzYy
+    N2IzYTlmNjJiYTFlNmFkN2E1ODk3YjFmMmRmYmE4MTJhMDE2Yjk=

data/lib/mblox.rb

@@ -1,5 +1,6 @@
 require "mblox/configuration"
 require "mblox/sms"
+require "mblox/sms_receipt"
 require "mblox/version"
 
 module Mblox
@@ -9,4 +10,5 @@ module Mblox
       self.config.logger.__send__(self.config.log_level, *args) if self.config.logger
     end
   end
+  class MissingExpectedXmlContentError < StandardError; end
 end

data/lib/mblox/sms.rb

@@ -12,7 +12,7 @@ module Mblox
     class BatchIdOutOfRangeError < ::ArgumentError; end
     MAX_LENGTH = 160
     MAX_SECTION_LENGTH = MAX_LENGTH - "(MSG XXX/XXX): ".size
-    ILLEGAL_CHARACTERS = /([^a-zA-Z0-9!"#$\%&'\(\)*+,-.\/:;<=>?@_£¤¥§¿i¡ÄÅÆÇÉÑÖØÜßáäåæèéìñòöøùü\n\r\tí ])/
+    ILLEGAL_CHARACTERS = /([^a-zA-Z0-9!"#\$\%&'\(\)*+,-.\/:;<=>?@_£¤¥§¿i¡ÄÅÆÇÉÑÖØÜßáäåæèéìñòöøùü\n\r\tí ])/
 
     attr_reader :phone, :message
 
@@ -32,7 +32,7 @@ module Mblox
       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}"
-      raise BatchIdOutOfRangeError, "batch_id must be in the range 1 to #{MAX_BATCH_ID}.  The batch_id specified (#{batch_id}) is out of range." if batch_id && (MAX_BATCH_ID < batch_id.to_i)
+      raise BatchIdOutOfRangeError, "batch_id must be in the range 1 to #{MAX_BATCH_ID}.  The batch_id specified (#{batch_id}) is out of range." if !batch_id.blank? && (MAX_BATCH_ID < batch_id.to_i)
       @batch_id = batch_id.to_i unless batch_id.blank?
     end
 

data/lib/mblox/sms_receipt.rb

@@ -0,0 +1,39 @@
+require 'active_model/serialization'
+require 'active_model/serializers/xml.rb'
+module Mblox
+  class SmsReceipt
+    attr_reader :batch_id, :subscriber_number, :timestamp, :msg_reference, :status, :reason
+    def initialize(xml)
+      data = Hash.from_xml(xml)['NotificationService']
+      raise MissingExpectedXmlContentError, "Xml should have contained a 'NotificationService' node, but was #{xml}" if data.blank?
+
+      data = data['NotificationList']
+      raise MissingExpectedXmlContentError, "Xml should have contained a 'NotificationService' -> 'NotificationList' node, but was #{xml}" if data.blank?
+
+      data = data['Notification']
+      raise MissingExpectedXmlContentError, "Xml should have contained a 'NotificationService' -> 'NotificationList' -> 'Notification' node, but was #{xml}" if data.blank?
+
+      @batch_id = data['BatchID'].to_i
+
+      data = data['Subscriber']
+      raise MissingExpectedXmlContentError, "Xml should have contained a 'NotificationService' -> 'NotificationList' -> 'Notification' -> 'Subscriber' node, but was #{xml}" if data.blank?
+
+      @subscriber_number = data['SubscriberNumber']
+      @subscriber_number = @subscriber_number[1..-1] if '1' == @subscriber_number[0]
+
+      unless data['TimeStamp'].blank?
+        @timestamp = begin
+          Time.strptime("#{data['TimeStamp']}+0000", '%Y%m%d%H%M%z')
+        rescue ArgumentError
+          nil
+        end
+      end
+
+      @timestamp = @timestamp.to_datetime if @timestamp
+
+      @msg_reference = data['MsgReference']
+      @status = data['Status']
+      @reason = data['Reason'].blank? ? nil : data['Reason'].to_i
+    end
+  end
+end

data/lib/mblox/sms_response.rb

@@ -10,7 +10,6 @@ require 'active_model/errors'
 
 module Mblox
   class SmsResponse
-    class MissingExpectedXmlContentError < StandardError; end
     class Result
       include ActiveModel::Validations
       validates_presence_of :text, :code, :message => "%{attribute} cannot be blank"
@@ -46,13 +45,13 @@ module Mblox
       result_list = data['NotificationResultList']
       raise MissingExpectedXmlContentError, "Xml should have contained a 'NotificationRequestResult' -> 'NotificationResultList' node, but was #{xml}" if result_list.blank?
       result_list = result_list['NotificationResult']
-      raise MissingExpectedXmlContentError, "Xml should have contained a 'NotificationRequestResult' -> 'NotificationResultList' => 'NotificationResult' node, but was #{xml}" if result_list.blank?
+      raise MissingExpectedXmlContentError, "Xml should have contained a 'NotificationRequestResult' -> 'NotificationResultList' -> 'NotificationResult' node, but was #{xml}" if result_list.blank?
       @result = Result.new(result_list['NotificationResultCode'], result_list['NotificationResultText'])
       @result = nil unless @result.valid?
 
       if @result.ok?
         result_list = result_list['SubscriberResult']
-        raise MissingExpectedXmlContentError, "Xml should have contained a 'NotificationRequestResult' -> 'NotificationResultList' => 'NotificationResult' -> 'SubscriberResult' node, but was #{xml}" if result_list.blank?
+        raise MissingExpectedXmlContentError, "Xml should have contained a 'NotificationRequestResult' -> 'NotificationResultList' -> 'NotificationResult' -> 'SubscriberResult' node, but was #{xml}" if result_list.blank?
         @subscriber_result = Result.new(result_list['SubscriberResultCode'], result_list['SubscriberResultText'])
         @subscriber_result = nil unless @subscriber_result.valid?
       end

data/lib/mblox/version.rb

@@ -1,3 +1,3 @@
 module Mblox
-  VERSION = "0.2.2"
+  VERSION = "0.2.5"
 end

data/spec/sms_receipt_spec.rb

@@ -0,0 +1,146 @@
+require "spec_helper"
+
+describe Mblox::SmsReceipt do
+  def msg_reference
+    'VIShbJoUqEcRLNDWosxwYOLP'
+  end
+
+  def batch_id
+    1234
+  end
+
+  def subscriber_number
+    '8885554444'
+  end
+
+  def status
+    'acked'
+  end
+
+  def reason
+    3
+  end
+
+  def valid
+    xml = Builder::XmlMarkup.new
+    xml.instruct!(:xml, :version => 1.0, :encoding => "ISO-8859-1", :standalone => :yes)
+    xml.NotificationService(:Version => "2.3") do |ns|
+      ns.NotificationList do |nl|
+        nl.Notification(:BatchID => batch_id) do |n|
+          n.Subscriber do |s|
+            s.SubscriberNumber("1#{subscriber_number}")
+            s.TimeStamp(201310071736)
+            s.MsgReference(msg_reference)
+            s.Status(status)
+            s.Reason(reason)
+          end
+        end
+      end
+    end
+    xml.target!
+  end
+
+  def missing_notification_service
+    xml = Builder::XmlMarkup.new
+    xml.instruct!(:xml, :version => 1.0, :encoding => "ISO-8859-1", :standalone => :yes)
+    xml.WrongNode(:Version => "2.3") do |ns|
+    end
+    xml.target!
+  end
+
+  def missing_notification_list
+    xml = Builder::XmlMarkup.new
+    xml.instruct!(:xml, :version => 1.0, :encoding => "ISO-8859-1", :standalone => :yes)
+    xml.NotificationService(:Version => "2.3") do |ns|
+    end
+    xml.target!
+  end
+
+  def missing_notification
+    xml = Builder::XmlMarkup.new
+    xml.instruct!(:xml, :version => 1.0, :encoding => "ISO-8859-1", :standalone => :yes)
+    xml.NotificationService(:Version => "2.3") do |ns|
+      ns.NotificationList do |nl|
+        nl.WrongNode do |n|
+        end
+      end
+    end
+    xml.target!
+  end
+
+    def missing_subscriber
+    xml = Builder::XmlMarkup.new
+    xml.instruct!(:xml, :version => 1.0, :encoding => "ISO-8859-1", :standalone => :yes)
+    xml.NotificationService(:Version => "2.3") do |ns|
+      ns.NotificationList do |nl|
+        nl.Notification(:BatchID => batch_id) do |n|
+        end
+      end
+    end
+    xml.target!
+  end
+
+  def unexpected_nested_values
+    xml = Builder::XmlMarkup.new
+    xml.instruct!(:xml, :version => 1.0, :encoding => "ISO-8859-1", :standalone => :yes)
+    xml.NotificationService(:Version => "2.3") do |ns|
+      ns.NotificationList do |nl|
+        nl.Notification(:BatchID => batch_id) do |n|
+          n.Subscriber do |s|
+            s.SubscriberNumber("2#{subscriber_number}")
+            s.TimeStamp('Abcdefg')
+            s.Reason
+          end
+        end
+      end
+    end
+    xml.target!
+  end
+
+  it "should access attributes for valid data" do
+    target = described_class.new(valid)
+    target.batch_id.should == batch_id
+    target.subscriber_number.should == subscriber_number
+    target.timestamp.should == DateTime.new(2013,10,7,17,36)
+    target.msg_reference.should == msg_reference
+    target.status.should == status
+    target.reason.should == reason
+  end
+
+  it "should raise error when missing notification service node" do
+    expect{described_class.new(missing_notification_service)}.to raise_error(Mblox::MissingExpectedXmlContentError, "Xml should have contained a 'NotificationService' node, but was #{missing_notification_service}")
+  end
+
+  it "should raise error when missing notification list node" do
+    expect{described_class.new(missing_notification_list)}.to raise_error(Mblox::MissingExpectedXmlContentError, "Xml should have contained a 'NotificationService' -> 'NotificationList' node, but was #{missing_notification_list}")
+  end
+
+  it "should raise error when missing notification node" do
+    expect{described_class.new(missing_notification)}.to raise_error(Mblox::MissingExpectedXmlContentError, "Xml should have contained a 'NotificationService' -> 'NotificationList' -> 'Notification' node, but was #{missing_notification}")
+  end
+
+  it "should raise error when missing subscriber node" do
+    expect{described_class.new(missing_subscriber)}.to raise_error(Mblox::MissingExpectedXmlContentError, "Xml should have contained a 'NotificationService' -> 'NotificationList' -> 'Notification' -> 'Subscriber' node, but was #{missing_subscriber}")
+  end
+
+  describe "subscriber_number" do
+    it "should not drop leading character unless it is '1'" do
+      target = described_class.new(unexpected_nested_values)
+      target.subscriber_number.should == "2#{subscriber_number}"
+    end
+  end
+
+  describe "reason" do
+    it "should leave reason blank if it is nil" do
+      target = described_class.new(unexpected_nested_values)
+      target.reason.should be_nil
+    end
+  end
+
+  describe "timestamp" do
+    it "should fail gracefully if it can't be converted into a DateTime" do
+      target = described_class.new(unexpected_nested_values)
+      target.timestamp.should be_nil
+    end
+  end
+end

data/spec/sms_spec.rb

@@ -133,7 +133,7 @@ describe Mblox::Sms do
       response.first.ok?.should be_false
     end
 
-    "\r\n!\"#$\%&'\(\)*+,-.\/:;<=>?@_£¤¥§¿iÄÅÆÇÉÑÖØÜßáäåæèéìñòöøùü\tí¡ ".each_char do |i|
+    "\r\n!\"#\$\%&'\(\)*+,-.\/:;<=>?@_£¤¥§¿iÄÅÆÇÉÑÖØÜßáäåæèéìñòöøùü\tí¡ ".each_char do |i|
       it "allows the special char #{i}, correctly escaping illegal XML characters where necessary" do
         response = Mblox::Sms.new(LANDLINE,"#{the_message}#{i}#{the_message}").send
         response.size.should eq(1)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mblox
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.5
 platform: ruby
 authors:
 - Isaac Betesh
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-10 00:00:00.000000000 Z
+date: 2013-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -125,10 +125,12 @@ files:
 - lib/mblox.rb
 - lib/mblox/configuration.rb
 - lib/mblox/sms.rb
+- lib/mblox/sms_receipt.rb
 - lib/mblox/sms_response.rb
 - lib/mblox/version.rb
 - mblox.gemspec
 - spec/configuration_spec.rb
+- spec/sms_receipt_spec.rb
 - spec/sms_response_result_spec.rb
 - spec/sms_spec.rb
 - spec/spec_helper.rb
@@ -180,6 +182,7 @@ summary: ! '# Mblox  This gem is for subscribers to Mblox to send SMS messages.
   5. Create new Pull Request'
 test_files:
 - spec/configuration_spec.rb
+- spec/sms_receipt_spec.rb
 - spec/sms_response_result_spec.rb
 - spec/sms_spec.rb
 - spec/spec_helper.rb