locasms 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 12853fa646f333fceb3ced3a9fa7c357bb51495d
-  data.tar.gz: 65f14f3bd5ec19d1a7a2b6da9d1cac23c72296d0
+  metadata.gz: b416a1dbc0a2828144adc3cad4f46f648febe3eb
+  data.tar.gz: 91c5669394594303a92d79ada598e96e2075198b
 SHA512:
-  metadata.gz: 117a31d340940d5c206576cf81f1571e1b6025811624a6b6ac1b1c074b5b0b8fd29e398c04e0890778132f82b381e50a110b32cb028ba823a7a0f233d10f527b
-  data.tar.gz: 44be44b781e6969014462c42cfe2e4e584eab62cd82ad04316b2afd8cbf0f654cb52221a7836ae920da59b879d4c790b08dfbdb712aa4fadc4dc0087c971e196
+  metadata.gz: c5d7e98110b2a257ec038716bbef0923fb49a9afc40edc84cbbe6a5ccd0bfebeaf5e9574219cf66ce329a36a7ad2083e786bf513d27c1212f31d031d7cc87327
+  data.tar.gz: 6e83d47e413f43a918f507e73b8130d8f0998c4b5caf3cdd43d86b1f67fe5964b68aba4baa9a75f6d0965199cd030487235ee167b43382a6d9605502a67732be

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
 rvm:
   - 1.9
-  - 2.0
+  - 2.0
+env:
+  - TRAVIS=true

data/README.md

@@ -34,10 +34,10 @@ cli.deliver 'my message', '1199998888', '5500002222'
 cli.deliver 'my message', ['1199998888', '5500002222']
 cli.deliver 'my message', %w(1199998888 5500002222)
 
-# scheluling the deliver of a message to one mobile
+# scheduling the deliver of a message to one mobile
 cli.deliver_at 'my message', '2013-10-12 20:33:00', '1155559999'
 
-# scheluling the deliver of a message to multiple mobiles at once
+# scheduling the deliver of a message to multiple mobiles at once
 cli.deliver_at 'my message', '2013-10-12 20:33:00', '1199998888,5500002222'
 cli.deliver_at 'my message', '2013-10-12 20:33:00', '1199998888', '5500002222'
 cli.deliver_at 'my message', '2013-10-12 20:33:00', ['1199998888', '5500002222']
@@ -64,4 +64,4 @@ cli.campaign_release '0000'
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
 
-[0]: http://locasms.com.br/#page_2/
+[0]: http://locasms.com.br/#page_2/

data/Rakefile

@@ -14,4 +14,4 @@ task :console do
   sh 'bundle exec irb -rubygems -I lib -r locasms.rb'
 end
 
-task :default => :console
+task :default => (ENV['TRAVIS'] ? :spec : :console)

data/lib/locasms/client.rb

@@ -22,8 +22,9 @@ module LocaSMS
     # @param [String] message message to be sent
     # @param [String,Array<String>] mobiles number of the mobiles to address the message
     # @return [String] campaign id on success
+    # @raise [LocaSMS::Exception] if bad numbers were given
     def deliver(message, *mobiles)
-      rest.get :sendsms, msg: message, numbers: mobiles.join(',')
+      rest.get :sendsms, msg: message, numbers: numbers(mobiles)
     end
 
     # Schedule the send of a message to one or more mobiles
@@ -31,13 +32,10 @@ module LocaSMS
     # @param [Time,DateTime,Fixnum,String] datetime
     # @param [String,Array<String>] mobiles number of the mobiles to address the message
     # @return UNDEF
+    # @raise [LocaSMS::Exception] if bad numbers were given
     def deliver_at(message, datetime, *mobiles)
-      datetime = Time.at(datetime)    if datetime.is_a? Fixnum
-      datetime = Time.parse(datetime) if datetime.is_a? String
-      datetime = datetime.to_time     if datetime.respond_to? :to_time
-
-      date, time = datetime.strftime('%d/%m/%Y|%H:%M').split('|')
-      rest.get :sendsms, numbers: mobiles.join(','), jobdate: date, jobtime: time
+      date, time = Helpers::DateTimeHelper.split datetime
+      rest.get :sendsms, msg: message, numbers: numbers(mobiles), jobdate: date, jobtime: time
     end
 
     # Get de current amount of sending credits
@@ -75,6 +73,19 @@ module LocaSMS
     def rest
       @rest ||= RestClient.new ENDPOINT, lgn: login, pwd: password
     end
+
+    # Processes and returns all good numbers in a string
+    # @param [Array<String>]
+    # @return [String]
+    # @raise [LocaSMS::Exception] if bad numbers were given
+    # @private
+    def numbers(*mobiles)
+      numbers = Numbers.new mobiles
+      return numbers.to_s unless numbers.bad?
+
+      raise Exception("Bad numbers were given: #{numbers.bad.join(',')}")
+    end
+
   end
 
 end

data/lib/locasms/exception.rb

@@ -0,0 +1,6 @@
+module LocaSMS
+
+  class Exception < ::Exception
+  end
+
+end

data/lib/locasms/helpers/date_time_helper.rb

@@ -0,0 +1,74 @@
+module LocaSMS
+module Helpers
+
+  # Helper class to handle with time parsing
+  class DateTimeHelper
+    # Parse a value into a time
+    # @param [Fixnum,String,DateTime,Time,#to_time] date
+    # @result [Time] return a parsed time
+    #
+    # @example
+    #
+    #     DateTimeHelper.parse '1977-03-14 14:12:00'
+    #     # => 1977-03-14 14:12:00 -0300
+    #
+    #     DateTimeHelper.split 227207520
+    #     # => 1977-03-14 14:12:00 -0300
+    #
+    def self.parse(date)
+      date = Time.at(date)    if date.is_a? Fixnum
+      date = Time.parse(date) if date.is_a? String
+      date = date.to_time     if date.respond_to? :to_time
+    end
+
+    # Breaks a given date in date and time
+    # @param [Fixnum,String,DateTime,Time,#to_time] date
+    # @result [Array<String>] an array containing respectively DD/MM/YYYY and HH:MM
+    #
+    # @example
+    #
+    #     DateTimeHelper.split Time.now
+    #     # => ['14/03/1977', '14:12']
+    #
+    #     DateTimeHelper.split 227207520
+    #     # => ['14/03/1977', '14:12']
+    #
+    def self.split(date)
+      parse(date).strftime('%d/%m/%Y %H:%M').split(' ')
+    end
+
+    # Parse a value into a time
+    # @param [Fixnum,String,DateTime,Time,#to_time] date
+    # @result [Time] return a parsed time
+    #
+    # @example
+    #
+    #     DateTimeHelper.parse '1977-03-14 14:12:00'
+    #     # => 1977-03-14 14:12:00 -0300
+    #
+    #     DateTimeHelper.split 227207520
+    #     # => 1977-03-14 14:12:00 -0300
+    #
+    def parse(date)
+      DateTimeHelper.parse date
+    end
+
+    # Breaks a given date in date and time
+    # @param [Fixnum,String,DateTime,Time,#to_time] date
+    # @result [Array<String>] an array containing respectively DD/MM/YYYY and HH:MM
+    #
+    # @example
+    #
+    #     DateTimeHelper.split Time.now
+    #     # => ['14/03/1977', '14:12']
+    #
+    #     DateTimeHelper.split 227207520
+    #     # => ['14/03/1977', '14:12']
+    #
+    def split(date)
+      DateTimeHelper.split date
+    end
+  end
+
+end
+end

data/lib/locasms/numbers.rb

@@ -0,0 +1,80 @@
+module LocaSMS
+
+  # Class that sanitizes and validates a list of mobile's numbers
+  class Numbers
+    attr_reader :good, :bad
+
+    # Creates a new instance of the class, separating good and bad numbers
+    # @param [Array<String>] numbers given mobile numbers
+    # @see #normalize
+    # @see #evaluate
+    def initialize(*numbers)
+      evaluated   = evaluate(numbers)
+      @good, @bad = evaluated[:good], evaluated[:bad]
+    end
+
+    # Checks if there are bad numbers
+    # @return [TrueClass, FalseClass] true if there are bad numbers
+    # @see #valid_number?
+    def bad?
+      not bad.empty?
+    end
+
+    # Clears all non digits from a mobile's number and converts into a normalized array
+    # @param [Array<String>] numbers list of mobile numbers to be clean
+    # @return [Array<String>] a normalized list of mobile numbers
+    # @example
+    #     numbers = Numbers.new
+    #     numbers.normalize '+55 (41) 8888-9999'
+    #     # => ['554188889999']
+    #     numbers.normalize '8888-9999', '7777-0000'
+    #     # => ['88889999','77770000']
+    #     numbers.normalize '8888-9999,7777-0000'
+    #     # => ['88889999','77770000']
+    #     numbers.normalize '8888-9999', ['AA', '6666-9999', '7777-0000'], '3333-4444,555-9999'
+    #     # => ['88889999','AA','66669999','77770000','33334444','5559999']
+    def normalize(*numbers)
+      numbers = numbers.join(',')
+        .split(',')
+        .map{|number| number.gsub(/[^0-9a-zA-Z]/, '') }
+        .delete_if{|number| number.empty? }
+    end
+
+    # Validates if a mobile's number has only digits
+    # @param [String] number given number to be validated
+    # @return [TrueClass, FalseClass] true if the number is valid
+    def valid_number?(number)
+      return false if number.nil? or number =~ /[^0-9a-zA-Z]/
+      [10, 11].include? number.size
+    end
+
+    # Evaluates a list of numbers and separat them in two groups. The good ones
+    # and the bad ones.
+    # @param [Array<String>] numbers given numbers to evaluate
+    # @return [Hash] containing two values. :good with the good numbers and :bad
+    # for the bad ones
+    # @example With only good numbers
+    #     Numbers.new.evaluate('4199998888','11777770000')
+    #     #=> {good: ['4199998888','11777770000'], bad: []}
+    # @example With only bad numbers
+    #     Numbers.new.evaluate('5551212')
+    #     #=> {good: [], bad: ['5551212']}
+    # @example With good and bad numbers mixed
+    #     Numbers.new.evaluate('4199998888','11777770000','5551212')
+    #     #=> {good: ['4199998888','11777770000'], bad: ['5551212']}
+    def evaluate(*numbers)
+      normalize(numbers).reduce({good: [], bad: []}) do |hash, number|
+        bucket = valid_number?(number) ? :good : :bad
+        hash[bucket] << number
+        hash
+      end
+    end
+
+    # Return all good numbers in a string comma joined
+    # @return [String] all good numbers in a string comma joined
+    def to_s
+      (good || []).join(',')
+    end
+  end
+
+end

data/lib/locasms/version.rb

@@ -1,3 +1,3 @@
 module LocaSMS
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/locasms.rb

@@ -1,4 +1,4 @@
-require "locasms/version"
+require 'locasms/version'
 
 autoload :JSON,       'json'
 autoload :RestClient, 'rest_client'
@@ -6,5 +6,11 @@ autoload :Logger,     'logger'
 
 module LocaSMS
   autoload :Client,     'locasms/client'
+  autoload :Exception,  'locasms/exception'
+  autoload :Numbers,    'locasms/numbers'
   autoload :RestClient, 'locasms/rest_client'
+
+  module Helpers
+    autoload :DateTimeHelper, 'locasms/helpers/date_time_helper'
+  end
 end

data/spec/lib/locasms/client_spec.rb

@@ -10,19 +10,66 @@ describe LocaSMS::Client do
   end
 
   describe '#deliver' do
-    before(:each) do
+    it 'Should send SMS' do
+      subject.should_receive(:numbers)
+        .once
+        .with([:a, :b, :c])
+        .and_return('XXX')
+
       rest_client.should_receive(:get)
         .once
-        .with(:sendsms, msg: 'given message', numbers:'1188882222,5577770000')
+        .with(:sendsms, msg: 'given message', numbers:'XXX')
+
+      subject.deliver 'given message', :a, :b, :c
     end
 
-    it{ subject.deliver 'given message', '1188882222,5577770000'      }
-    it{ subject.deliver 'given message', %w(1188882222 5577770000)    }
-    it{ subject.deliver 'given message', '1188882222', '5577770000'   }
-    it{ subject.deliver 'given message', ['1188882222', '5577770000'] }
+    it 'Should not send SMS' do
+      subject.should_receive(:numbers)
+        .once
+        .with([:a, :b, :c])
+        .and_raise(LocaSMS::Exception)
+
+      rest_client.should_receive(:get).never
+
+      lambda{ subject.deliver('given message', :a, :b, :c) }.should raise_error(LocaSMS::Exception)
+    end
   end
 
-  it '#deliver_at'
+  describe '#deliver_at' do
+    it 'Should send SMS' do
+      subject.should_receive(:numbers)
+        .once
+        .with([:a, :b, :c])
+        .and_return('XXX')
+
+      LocaSMS::Helpers::DateTimeHelper.should_receive(:split)
+        .once
+        .with(:datetime)
+        .and_return(%w[date time])
+
+      rest_client.should_receive(:get)
+        .once
+        .with(:sendsms, msg: 'given message', numbers:'XXX', jobdate: 'date', jobtime: 'time')
+
+      subject.deliver_at 'given message', :datetime, :a, :b, :c
+    end
+
+    it 'Should not send SMS' do
+      subject.should_receive(:numbers)
+        .once
+        .with([:a, :b, :c])
+        .and_raise(LocaSMS::Exception)
+
+      LocaSMS::Helpers::DateTimeHelper.should_receive(:split)
+        .once
+        .with(:datetime)
+        .and_return(%w[date time])
+
+      rest_client.should_receive(:get).never
+
+      lambda{ subject.deliver_at('given message', :datetime, :a, :b, :c) }.should raise_error(LocaSMS::Exception)
+    end
+  end
 
   describe '#balance' do
     it 'Should check param assignment' do

data/spec/lib/locasms/helpers/date_time_helper_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe LocaSMS::Helpers::DateTimeHelper do
+  subject { LocaSMS::Helpers::DateTimeHelper }
+
+  describe '#parse' do
+    it 'Should call the class method' do
+      subject.should_receive(:parse)
+        .once
+        .with(:value)
+
+      subject.new.parse(:value)
+    end
+  end
+
+  describe '#split' do
+    it 'Should call the class method' do
+      subject.should_receive(:split)
+        .once
+        .with(:value)
+
+      subject.new.split(:value)
+    end
+  end
+
+  describe '.parse' do
+    let(:expected) { Time.parse '1977-03-14 14:12:00' }
+
+    def try_for(value)
+      subject.parse(value) == expected
+    end
+
+    it { try_for DateTime.parse('1977-03-14 14:12:00') }
+    it { try_for Time.parse('1977-03-14 14:12:00')     }
+    it { try_for '1977-03-14 14:12:00'                 }
+    it { try_for 227207520                             }
+  end
+
+  describe '.split' do
+    it 'Should break a date into date and time' do
+      subject.should_receive(:parse)
+        .once
+        .with(:datetime)
+        .and_return(Time.parse('1977-03-14 14:12:00'))
+
+      subject.split(:datetime).should == %w(14/03/1977 14:12)
+    end
+  end
+
+end

data/spec/lib/locasms/numbers_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe LocaSMS::Numbers do
+  subject { LocaSMS::Numbers.new }
+
+  describe '.initialize' do
+    subject do
+      LocaSMS::Numbers.any_instance
+        .should_receive(:evaluate)
+        .once
+        .with([:numbers])
+        .and_return({ good: [1,3], bad: [2,4] })
+      LocaSMS::Numbers.new :numbers
+    end
+
+    it{ subject.good.should == [1,3] }
+    it{ subject.bad.should == [2,4]  }
+  end
+
+  describe '#normalize' do
+    it{ subject.normalize('+55 (11) 8888-9999').should == %w(551188889999) }
+    it{ subject.normalize('55', ['11', '22']).should == %w(55 11 22) }
+    it{ subject.normalize(['55', 'ZZ', '22']).should == %w(55 ZZ 22) }
+    it{ subject.normalize('55,44,33', ['ZZ', '22,11']).should == %w(55 44 33 ZZ 22 11) }
+    it{ subject.normalize(55, [11, 22]).should == %w(55 11 22) }
+    it{ subject.normalize('Z').should == ['Z'] }
+    it{ subject.normalize(nil).should == [] }
+  end
+
+  describe '#valid_number?' do
+    it{ subject.valid_number?('+55 (11) 8888-9999').should be_false }
+    it{ subject.valid_number?('88889999').should be_false }
+    it{ subject.valid_number?('988889999').should be_false }
+    it{ subject.valid_number?('ABC').should be_false }
+    it{ subject.valid_number?('').should be_false }
+    it{ subject.valid_number?(nil).should be_false }
+
+    it{ subject.valid_number?('1188889999').should be_true }
+    it{ subject.valid_number?('11988889999').should be_true }
+  end
+
+  describe '#evaluate' do
+    it 'Should separate numbers in good and bad' do
+      subject.should_receive(:normalize)
+        .once
+        .with([:numbers])
+        .and_return([:good, :bad])
+      subject.should_receive(:valid_number?)
+        .once
+        .with(:good)
+        .and_return(true)
+      subject.should_receive(:valid_number?)
+        .once
+        .with(:bad)
+        .and_return(false)
+      subject.evaluate(:numbers).should == { good: [:good], bad: [:bad] }
+    end
+  end
+
+  describe '#bad?' do
+    it{ subject.should_receive(:bad).once.and_return([ ]); subject.bad?.should be_false }
+    it{ subject.should_receive(:bad).once.and_return([1]); subject.bad?.should be_true  }
+  end
+
+  describe '#to_s' do
+    it 'Should return and empty string' do
+      subject.to_s.should == ''
+    end
+
+    it 'Should return all good numbers in a string comma separated' do
+      subject.should_receive(:good)
+        .once
+        .and_return([1,2,3,4])
+      subject.to_s.should == '1,2,3,4'
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: locasms
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Adilson Carvalho
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-12 00:00:00.000000000 Z
+date: 2013-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -181,10 +181,15 @@ files:
 - Rakefile
 - lib/locasms.rb
 - lib/locasms/client.rb
+- lib/locasms/exception.rb
+- lib/locasms/helpers/date_time_helper.rb
+- lib/locasms/numbers.rb
 - lib/locasms/rest_client.rb
 - lib/locasms/version.rb
 - locasms.gemspec
 - spec/lib/locasms/client_spec.rb
+- spec/lib/locasms/helpers/date_time_helper_spec.rb
+- spec/lib/locasms/numbers_spec.rb
 - spec/lib/locasms/rest_client_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -214,6 +219,8 @@ specification_version: 4
 summary: Cliente para o serviço de disparo de SMS da LocaSMS
 test_files:
 - spec/lib/locasms/client_spec.rb
+- spec/lib/locasms/helpers/date_time_helper_spec.rb
+- spec/lib/locasms/numbers_spec.rb
 - spec/lib/locasms/rest_client_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb