active_smsgate 0.0.2 → 0.0.3

data/lib/active_smsgate/gateway.rb

@@ -1,17 +1,39 @@
 # -*- coding: utf-8 -*-
 module ActiveSmsgate #:nodoc:
   module Gateway #:nodoc:
+=begin rdoc
+В каждом шлюзе нужно прописать три метода
+  # Выполнение отправки смс завершено
+  def complete;  end
+  alias :complete? :complete
 
+  # Смс досталена
+  def success; end
+  alias :success? :success
+
+  # Смс не доставлена
+  def failure; end
+  alias :failure? :failure
+=end
     class << self
       # Список поддерживаемых
       def support_gateways
-        [{:class => 'amegainform',:desc => 'www.amegainform.ru' }]
+        Dir["#{File.dirname(__FILE__)}/gateways/**/*.rb"].map { |gw|
+          gateway = "active_smsgate/gateway/#{File.basename(gw, ".rb")}".classify.constantize
+          { :class => File.basename(gw, ".rb"),  :alias => gateway::ALIAS,
+            :short_desc => gateway::SHORT_DESC, :desc => gateway::DESC}    }
+      end
+
+      # получение шлюза по его имени
+      def gateway(gw)
+        "active_smsgate/gateway/#{gw.to_s}".classify.constantize
       end
+
     end
 
     class Gateway
       include HTTParty
-      attr_accessor :login, :password, :use_ssl
+      attr_accessor :login, :password, :use_ssl, :errors
 
       # Initialize a new gateway.
       # ==== Параметры
@@ -33,6 +55,17 @@ module ActiveSmsgate #:nodoc:
       # Использовать резервные сервера
       def use_of_backup_server?; @use_of_backup_server  end
 
+      # Получение uri смс сервиса
+      def uri
+        self.class.default_options[:base_uri].gsub!(/^https?:\/\//i, '')
+        "http#{'s' if use_ssl?}://#{self.class.default_options[:base_uri]}"
+      end
+
+      def valid?
+        @errors.blank?
+      end
+
+
     end
   end
 end

data/lib/active_smsgate/gateways/amegainform.rb

@@ -1,22 +1,63 @@
 # -*- coding: utf-8 -*-
-
 module ActiveSmsgate #:nodoc:
-  # «Амега Информ» – http://amegainform.ru/
-  # это сервис  массовой рассылки, приема SMS и голосовых сообщений.
-
   module Gateway #:nodoc:
+
+=begin rdoc
+   «Амега Информ» – http://amegainform.ru/
+   это сервис  массовой рассылки, приема SMS и голосовых сообщений.
+
+      # Возвращаемые данные
+      # <output>
+      # <result sms_group_id="996">
+      # <sms id="99991" smstype="SENDSMS" phone="+79999999991" sms_res_count="1"><![CDATA[Привет]]></sms>
+      # <sms id="99992" smstype="SENDVOICE" phone="+79999999992" sms_res_count="38"><![CDATA[%PAUSE=1000%%SYNTH=Vika%Привет друг%SAMPLE=#1525%%PAUSE=1000%%SYNTH=Vika%С днём рождения!]]></sms>
+      # </result>
+      # <output>
+
+
+      # Возвращаемые данные
+      # -------------------------------------------------------------------
+      # SMS_ID - ID сообщения
+      # SMS_GROUP_ID - ID рассылки сообщений
+      # SMSTYPE - тип сообщения
+      # CREATED - дата и время создания сообщения
+      # AUL_USERNAME - Имя пользователя создавшего сообщение
+      # AUL_CLIENT_ADR - IP адрес пользователя создавшего сообщение
+      # SMS_SENDER - Имя отправителя сообщения
+      # SMS_TARGET - Телефон адресата
+      # SMS_RES_COUNT - Кол-во единиц ресурсов на данное сообщение
+      # SMS_TEXT - Текст сообщения
+      # SMSSTC_CODE - Код статуса доставки сообщения
+      # -- queued - сообщение в очереди отправки
+      # -- wait -	передано оператору на отправку
+      # -- accepted -	сообщение принято оператором, но статус доставки неизвестен
+      # -- delivered -сообщение доставлено
+      # -- not_delivered - сообщение не доставлено
+      # -- failed - ошибка при работе по сообщению
+      # SMS_STATUS - Текстовое описание статуса доставки сообщения
+      # SMS_CLOSED - [0,1] 0 - сообщения находится в процессинге.
+      #                    1 = работа по отправке сообщения завершена
+      # SMS_SENT - [0,1] 0 - сообщение не отослано. 1 = сообщение отослано успешно
+      # SMS_CALL_DURATION - Время,
+      #              в течение которого было установлено соединение для отправки сообщения.
+      # SMS_DTMF_DIGITS - Что пользователь нажимал в сеансе разговора (для SENDVOICE (в разработке))
+      # SMS_CLOSE_TIME - Время завершения работы по сообщению.
+
+
+=end
     class Amegainform < Gateway
 
+      CLASS_ID = 'amegainform'
+      ALIAS = 'www.amegainform.ru'
+      SHORT_DESC = 'Шлюз sms рассылок www.amegainform.ru'
+      DESC = "Описание шлюза"
+
       headers 'Content-Type' => 'application/x-www-form-urlencoded; charset=UTF-8'
       base_uri 'http://service.amega-inform.ru'
 
       # Адреса резервных серверов: service-r1.amegainform.ru и service-r2.amegainform.ru
 
       # Создание нового шлюза  AmegaInformGateway
-      # Для работы со шлюзом необходимы логин и пароль
-      #
-      # ==== Параметры
-      #
       # * <tt>:login</tt> -- REQUIRED
       # * <tt>:password</tt> -- REQUIRED
       def initialize(options = {})
@@ -29,10 +70,10 @@ module ActiveSmsgate #:nodoc:
       # OVERDRAFT           [максимальных уход в минус]
       # PARENT_DEBT         [задолженность]
       def balance
-        @response = self.class.post("#{uri}/sendsms",
+        response = self.class.post("#{uri}/sendsms",
                                     :query => { :action => "balance"}.merge(auth_options))
-        if @response.code == 200
-          xml = Zlib::GzipReader.new( StringIO.new( @response ) ).read
+        if response.code == 200
+          xml = Zlib::GzipReader.new( StringIO.new( response ) ).read
           doc = Nokogiri::XML(xml)
           {
             :balance =>   (doc.at("//balance//AGT_BALANCE").inner_html rescue 0),
@@ -40,14 +81,10 @@ module ActiveSmsgate #:nodoc:
             :overdraft => (doc.at("//balance//OVERDRAFT").inner_html   rescue 0)
           }
         else
-          @response
-        #   raise
+          raise
         end
-
-        # error
-      # rescue
-        # nil
-
+      rescue
+        nil
       end
 
       # Отправка сообщения
@@ -59,107 +96,94 @@ module ActiveSmsgate #:nodoc:
       # * sender  - имя отправителя, зарегистрированного в системе service.amegainform.ru.
       #            NULL - используется имя отправителя по умолчанию.
 
-
-      # Nokogiri::XML::Builder.new do |xml|
-      #   xml.output do
-      #     xml.result(:sms_group_id => 996) do
-      #       xml.sms(:id => '23234',:smstyoe => 'sendsms', :phone => '333', :sms_res_count => '1' ) {
-      #         xml << "\<![CDATA[Привет]]\>"}
-      #       xml.sms(:id => '999',:smstyoe => 'sendsms', :phone => '22', :sms_res_count => '11' ) {
-      #         xml << "\<![CDATA[---------Привет---------]]\>"}
-      #     end
-      #   end
-      # end
-
-
-      # Возвращаемые данные
-      # <output>
-      # <result sms_group_id="996">
-      # <sms id="99991" smstype="SENDSMS" phone="+79999999991" sms_res_count="1"><![CDATA[Привет]]></sms>
-      # <sms id="99992" smstype="SENDVOICE" phone="+79999999992" sms_res_count="38"><![CDATA[%PAUSE=1000%%SYNTH=Vika%Привет друг%SAMPLE=#1525%%PAUSE=1000%%SYNTH=Vika%С днём рождения!]]></sms>
-      # </result>
-      # <output>
-
-      def deliver(options = { :sender => nil})
+      # Возвращаемые параметры
+      # sms_id - ид в сервисе шлюза
+      # sms_count - сколько смс потрачено на отправку сообщения
+      # phone - номер куда было отправлено сообщение
+      # Если @errors не пустое то возвращает nil
+      def deliver_sms(options = { :sender => nil})
         @options = {
-          :action  => "post_sms",
-          :message => options[:message],
+          :action  => "post_sms", :message => options[:message],
           :target  => options[:phones],
           :sender  => options[:sender] }
 
-        @response = self.class.post("#{uri}/sendsms", :query => @options.merge(auth_options))
-        if @response.code == 200
-          xml = Zlib::GzipReader.new( StringIO.new( @response ) ).read
+        response = self.class.post("#{uri}/sendsms", :query => @options.merge(auth_options))
+        xml = Zlib::GzipReader.new( StringIO.new( response ) ).read
+        if response.code == 200
           parse(xml)
-          { :sms => @sms, :messages => @messages, :errors => @errors}
+          @sms.map{|x| x.merge({ :sms_group_id => x[:sms_group_id],
+                                 :sms_id => x[:id], :phone => x[:phone], :sms_count => x[:sms_res_count] })}
+
         else
           raise
         end
       rescue
+        STDERR.puts  " #{$!.inspect} "
+        STDERR.puts  " #{xml} " if xml
         nil
       end
 
 
-
       # Получение данных и статусов сообщений
       # sms_id - ид смс
-
-
-      # Возвращаемые данные
-      # -------------------------------------------------------------------
-      # SMS_ID - ID сообщения
-      # SMS_GROUP_ID - ID рассылки сообщений
-      # SMSTYPE - тип сообщения
-      # CREATED - дата и время создания сообщения
-      # AUL_USERNAME - Имя пользователя создавшего сообщение
-      # AUL_CLIENT_ADR - IP адрес пользователя создавшего сообщение
-      # SMS_SENDER - Имя отправителя сообщения
-      # SMS_TARGET - Телефон адресата
-      # SMS_RES_COUNT - Кол-во единиц ресурсов на данное сообщение
-      # SMS_TEXT - Текст сообщения
-      # SMSSTC_CODE - Код статуса доставки сообщения
-      # -- queued - сообщение в очереди отправки
-      # -- wait -	передано оператору на отправку
-      # -- accepted -	сообщение принято оператором, но статус доставки неизвестен
-      # -- delivered -сообщение доставлено
-      # -- not_delivered - сообщение не доставлено
-      # -- failed - ошибка при работе по сообщению
-      # SMS_STATUS - Текстовое описание статуса доставки сообщения
-      # SMS_CLOSED - [0,1] 0 - сообщения находится в процессинге.
-      #                    1 = работа по отправке сообщения завершена
-      # SMS_SENT - [0,1] 0 - сообщение не отослано. 1 = сообщение отослано успешно
-      # SMS_CALL_DURATION - Время,
-      #              в течение которого было установлено соединение для отправки сообщения.
-      # SMS_DTMF_DIGITS - Что пользователь нажимал в сеансе разговора (для SENDVOICE (в разработке))
-      # SMS_CLOSE_TIME - Время завершения работы по сообщению.
-
-      def reply(sms_id)
-        @options = { :action => "status", :sendtype => "SENDSMS", :sms_id => sms_id }
-        @response = self.class.post("#{uri}/sendsms", :query => @options.merge(auth_options))
-
-        if @response.code == 200
-          xml = Zlib::GzipReader.new( StringIO.new( @response ) ).read
-          doc = Nokogiri::XML(xml)
+      # type - sms - запрашиваем статус по одному сообщению
+      #      - sms_group - запрашиваем статусы по рассылке
+
+      # Возвращаем hash
+      # где обязательно есть
+      # sms_id    - ид в сервисе шлюза
+      # sms_count - кол-во смс потраченное на отправку сообщения
+      # phone     - телефон
+
+      def reply_sms(sms_id, sms_type = :sms)
+        raise unless [:sms, :sms_group].include?(sms_type)
+
+        @options = { :action => "status", :sendtype => "SENDSMS", "#{sms_type}_id" => sms_id }
+        response = self.class.post("#{uri}/sendsms", :query => @options.merge(auth_options))
+        xml = Zlib::GzipReader.new( StringIO.new( response ) ).read
+        if response.code == 200
           parse(xml)
-          { :sms => @sms, :messages => @messages, :errors => @errors}
+          if sms_type == :sms
+            @messages.map{ |msg| msg.merge({ :sms_id => msg[:sms_id],:sms_count => msg[:sms_res_count],
+                                             :phone => msg[:sms_target] }) }.find{ |x| x[:sms_id] ==  sms_id.to_s }
+          else
+            @messages.map{ |msg| msg.merge({ :sms_id => msg[:sms_id],
+                                             :sms_count => msg[:sms_res_count], :phone => msg[:sms_target] }) }
+          end
         else
           raise
         end
       rescue
-        nil
+        STDERR.puts  " #{$!.inspect} "
+        STDERR.puts  " #{xml} " if xml
+        false
       end
 
+      # Выполнение отправки смс завершено
+      def complete_sms(sms_id)
+        @message ||= reply_sms(sms_id)
+        true if @message[:sms_closed].to_i == 1
+      end
+      alias :complete_sms? :complete_sms
 
-      private
-      # Возвращает параметры для авторизации
-      def auth_options; { :user => @login, :pass => @password }  end
+      # Смс досталена
+      def success_sms(sms_id)
+        @message ||= reply_sms(sms_id)
+        true if @message[:sms_sent].to_i == 1
+      end
+      alias :success_sms? :success_sms
 
-      # Получение uri смс сервиса
-      def uri
-        self.class.default_options[:base_uri].gsub!(/^https?:\/\//i, '')
-        "http#{'s' if use_ssl?}://#{self.class.default_options[:base_uri]}"
+      # Смс не доставлена
+      def failure_sms(sms_id)
+        @message ||= reply_sms(sms_id)
+        true if @message[:sms_sent].to_i != 1
       end
+      alias :failure_sms? :failure_sms
+
+      private
 
+      # Возвращает параметры для авторизации
+      def auth_options; { :user => @login, :pass => @password }  end
 
       # Разбираем ответ от сервиса amegainform
       def parse(xml)
@@ -169,6 +193,7 @@ module ActiveSmsgate #:nodoc:
         @sms = doc.at("//output//result") && doc.at("//output//result").
           children.search("//sms").map {|x|
           _x ={}
+          doc.at("//output//result").each { |v,l| _x[v.downcase.to_sym] = l }
           x.each { |v,l| _x[v.downcase.to_sym] = l }
           _x[:text] = x.inner_html
           _x

data/lib/active_smsgate.rb

@@ -6,6 +6,7 @@ require 'httparty'
 require 'nokogiri'
 require 'digest'
 require "zlib"
+require 'active_resource'
 
 require "active_smsgate/gateway"
 Dir[File.join(File.dirname(__FILE__), 'active_smsgate','gateways','**','*.rb')].each { |gw| require gw }

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Pechnikov Maxim
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-09 00:00:00 +06:00
+date: 2010-05-13 00:00:00 +06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -57,6 +57,20 @@ dependencies:
         version: 0.5.2
   type: :runtime
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activeresource
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
+  type: :runtime
+  version_requirements: *id004
 description: Active Smsgate
 email: parallel588@gmail.com
 executables: []