routo 0.0.2

data/lib/routo.rb

@@ -0,0 +1,46 @@
+require 'routo/exception'
+require 'routo/number'
+require 'routo/message'
+require 'pony'
+module Routo
+  mattr_accessor :username
+  @@username = ""
+  mattr_accessor :password
+  @@password = ""
+  mattr_accessor :http_api_url
+  @@http_api_url = "http://smsc5.routotelecom.com/SMSsend"
+  mattr_accessor :http_api_url_backup
+  @@http_api_url_backup = "http://smsc56.routotelecom.com/SMSsend"
+  mattr_accessor :ownnum
+  mattr_accessor :type
+  mattr_accessor :delivery
+  @@delivery = 0
+
+  # Email Options
+  # config.email                 : recipient for the email notifications (default: nil)
+  # config.email_options         : Hash with email config (smtp, sendmail, ...). We use the Pony gem to send mails, this hash will be send to Pony.options
+  # config.seconds_between_mails : Minimum time (in seconds) between 2 mails with the same subject
+  mattr_accessor :email
+  mattr_accessor :email_options
+  @@email_options = {}
+  mattr_accessor :seconds_between_mails
+  @@seconds_between_mails = 600
+  
+  mattr_accessor :no_credits_left
+  @@no_credits_left = {:subject => 'Routo Messaging: no credits left', :body => 'You do not have any credit left on Routo messaging. You should buy some more credits in order to be able to send more SMS.'}
+  mattr_accessor :no_credits_left_sent_at
+
+  mattr_accessor :using_backup_url
+  @@using_backup_url = {:subject => 'Routo Messaging: using backup url', :body => 'The primary Routo Messaging http API url was not responding correctly. We tried the backup API.'}
+  mattr_accessor :using_backup_url_sent_at
+
+  def self.config
+    yield self
+    Pony.options = @@email_options
+  end
+
+  def self.send_sms msg, *numbers
+    Message.new(msg).send_sms(*numbers)
+  end
+  
+end

data/lib/routo/exception.rb

@@ -0,0 +1,12 @@
+module Routo
+
+  module Exception
+    class Base < ::Exception
+      def initialize msg
+        super(msg)
+      end
+    end
+  end
+
+end
+Dir[File.expand_path('../exception/', __FILE__)+'/*.rb'].each {|file| require(file) }

data/lib/routo/exception/auth_failed.rb

@@ -0,0 +1,7 @@
+module Routo
+  module Exception
+    class AuthFailed < Base
+
+    end
+  end
+end

data/lib/routo/exception/bad_operator.rb

@@ -0,0 +1,7 @@
+module Routo
+  module Exception
+    class BadOperator < Base
+
+    end
+  end
+end

data/lib/routo/exception/error.rb

@@ -0,0 +1,7 @@
+module Routo
+  module Exception
+    class Error < Base
+
+    end
+  end
+end

data/lib/routo/exception/failed.rb

@@ -0,0 +1,7 @@
+module Routo
+  module Exception
+    class Failed < Base
+
+    end
+  end
+end

data/lib/routo/exception/no_credits_left.rb

@@ -0,0 +1,11 @@
+module Routo
+  module Exception
+    class NoCreditsLeft < Base
+      def initialize msg
+        super(msg)
+        Pony.mail(:to => Routo.email, :subject => Routo.no_credits_left[:subject], :body => Routo.no_credits_left[:body]) if Routo.email && Routo.no_credits_left.present? && Routo.no_credits_left_sent_at.to_i<(Time.now.to_i-Routo.seconds_between_mails)
+        Routo.no_credits_left_sent_at = Time.now
+      end
+    end
+  end
+end

data/lib/routo/exception/no_message.rb

@@ -0,0 +1,7 @@
+module Routo
+  module Exception
+    class NoMessage < Base
+
+    end
+  end
+end

data/lib/routo/exception/not_allowed.rb

@@ -0,0 +1,7 @@
+module Routo
+  module Exception
+    class NotAllowed < Base
+
+    end
+  end
+end

data/lib/routo/exception/system_error.rb

@@ -0,0 +1,7 @@
+module Routo
+  module Exception
+    class SystemError < Base
+
+    end
+  end
+end

data/lib/routo/exception/too_long.rb

@@ -0,0 +1,7 @@
+module Routo
+  module Exception
+    class TooLong < Base
+
+    end
+  end
+end

data/lib/routo/exception/too_many_numbers.rb

@@ -0,0 +1,7 @@
+module Routo
+  module Exception
+    class TooManyNumbers < Base
+
+    end
+  end
+end

data/lib/routo/exception/wrong_format.rb

@@ -0,0 +1,7 @@
+module Routo
+  module Exception
+    class WrongFormat < Base
+
+    end
+  end
+end

data/lib/routo/exception/wrong_message.rb

@@ -0,0 +1,7 @@
+module Routo
+  module Exception
+    class WrongMessage < Base
+
+    end
+  end
+end

data/lib/routo/exception/wrong_number.rb

@@ -0,0 +1,7 @@
+module Routo
+  module Exception
+    class WrongNumber < Base
+
+    end
+  end
+end

data/lib/routo/exception/wrong_type.rb

@@ -0,0 +1,7 @@
+module Routo
+  module Exception
+    class WrongType < Base
+
+    end
+  end
+end

data/lib/routo/message.rb

@@ -0,0 +1,70 @@
+module Routo
+
+  class Message
+
+    attr_accessor :text
+
+    def initialize text
+      @text = text
+      generate_mess_id
+    end
+
+    def send_sms *numbers
+      options = numbers.last.is_a?(Hash) ? numbers.last : {}
+      recipients = numbers.map{|n| Number.new(n)}
+      begin
+        parse_response(Net::HTTP.post_form(URI.parse(Routo.http_api_url), params(*recipients, options)))
+      rescue Routo::Exception::SystemError, Routo::Exception::Failed # trying with backup url if Routo returns an internal error
+        begin # here a mail error should not prevent the sms to be send
+          Pony.mail(:to => Routo.email, :subject => Routo.using_backup_url[:subject], :body => Routo.using_backup_url[:body]) if Routo.email && Routo.using_backup_url.present? && Routo.using_backup_url_sent_at.to_i<(Time.now.to_i-Routo.seconds_between_mails)
+          Routo.using_backup_url_sent_at = Time.now
+        ensure
+          parse_response(Net::HTTP.post_form(URI.parse(Routo.http_api_url_backup), params(*recipients, options)))
+        end
+      end
+    end
+
+    private
+
+    def params *number_objects, options
+      {:user => Routo.username,
+       :pass => URI.encode(Routo.password),
+       :number => number_objects.map(&:number).join(','),
+       :ownnum => Routo.ownnum,
+       :message => URI.encode(@text),
+       :type => Routo.type,
+       :delivery => Routo.delivery,
+       :mess_id => @mess_id}.merge(options)
+    end
+
+    def generate_mess_id
+      chars = ("A".."Z").to_a + ("0".."9").to_a
+      @mess_id = Array.new(30){||chars[rand(chars.size)]}.join
+    end
+
+    def parse_response rep
+      Rails.logger.debug "body: "+rep.body.inspect
+      Rails.logger.debug "msg: "+rep.message.inspect
+      case rep.body
+        when /success/i           then return true
+        when /error/i             then raise Routo::Exception::Error.new(rep.body)
+        when /auth_failed/i       then raise Routo::Exception::AuthFailed.new(rep.body)
+        when /wrong_number/i      then raise Routo::Exception::WrongNumber.new(rep.body)
+        when /not_allowed/i       then raise Routo::Exception::NotAllowed.new(rep.body)
+        when /too_many_numbers/i  then raise Routo::Exception::TooManyNumbers.new(rep.body)
+        when /no_message/i        then raise Routo::Exception::NoMessage.new(rep.body)
+        when /too_long/i          then raise Routo::Exception::TooLong.new(rep.body)
+        when /wrong_type/i        then raise Routo::Exception::WrongType.new(rep.body)
+        when /wrong_message/i     then raise Routo::Exception::WrongMessage.new(rep.body)
+        when /wrong_format/i      then raise Routo::Exception::WrongFormat.new(rep.body)
+        when /bad_operator/i      then raise Routo::Exception::BadOperator.new(rep.body)
+        when /failed/i            then raise Routo::Exception::Failed.new(rep.body)
+        when /sys_error/i         then raise Routo::Exception::SystemError.new(rep.body)
+        when /no credits left/i   then raise Routo::Exception::NoCreditsLeft.new(rep.body)
+        else raise Routo::Exception::Base.new(rep.body)
+      end
+    end
+
+  end
+
+end

data/lib/routo/number.rb

@@ -0,0 +1,13 @@
+module Routo
+
+  class Number
+    attr_accessor :number
+    def initialize number
+      @number = number
+    end
+    def send_sms msg
+      Message.new(msg).send_sms(@number)
+    end
+  end
+
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: routo
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Adrien Rambert
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-22 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: pony
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id001
+description: Sending sms with Routo Messaging HTTP API.
+email: arambert@weboglobin.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/routo/exception/auth_failed.rb
+- lib/routo/exception/bad_operator.rb
+- lib/routo/exception/error.rb
+- lib/routo/exception/failed.rb
+- lib/routo/exception/no_credits_left.rb
+- lib/routo/exception/no_message.rb
+- lib/routo/exception/not_allowed.rb
+- lib/routo/exception/system_error.rb
+- lib/routo/exception/too_long.rb
+- lib/routo/exception/too_many_numbers.rb
+- lib/routo/exception/wrong_format.rb
+- lib/routo/exception/wrong_message.rb
+- lib/routo/exception/wrong_number.rb
+- lib/routo/exception/wrong_type.rb
+- lib/routo/exception.rb
+- lib/routo/message.rb
+- lib/routo/number.rb
+- lib/routo.rb
+has_rdoc: true
+homepage: http://www.weboglobin.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.3.6
+requirements: 
+- none
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Sending sms with Routo Messaging.
+test_files: []
+