mfms 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90548a57b075fcd5f84cd9e0b3491bd988d5f3b0
-  data.tar.gz: bfab3bc9ad2ec73d9173ca590e483d13cc735a48
+  metadata.gz: 6275368229d65373594802e1ea72a218dfde252b
+  data.tar.gz: 6f8c06258ad905b2904ca677a3b6b0d3628e0524
 SHA512:
-  metadata.gz: b402976de6632c51cf29beff6dee03cb05f6556cce7c8b3357f34aa53867b4258b883f48ca7ae1f535bc99d090d2702b4ed836773fd2fe6e86e886d43a6eb42f
-  data.tar.gz: 7d3e369a6eab28b6d65ca2aefe6ff83ce713ebbe27c1ff5b44e57755735b999b719375001a9cd3dd00d2643eecaef110ee3197f4dbd16fb60531afff25a68999
+  metadata.gz: a90c7ac25217b7810c0646db83bd8eb9aaed73f5c3518c9634c99313ac145e29ae5cdc8c878b7d19fa72fed1496aec83e365d07ca5a226f546bac61a707cca07
+  data.tar.gz: 9c90c71176091a054a52db407a36b6c1f040c5b1064e84cbbcd03142a972a97897589306ddabdf2330e4226de89cc12049d68cc1a9f6122770bfd76b493499f9

data/README.md

@@ -18,7 +18,7 @@ Or install it yourself as:
 
 ## Usage
     
-Define settinfs:
+Define settings:
 
     Mfms::SMS.settings = {
       :login      => 'login',
@@ -27,24 +27,32 @@ Define settinfs:
       :port       => port,
       :ssl_port   => ssl_port,
       :cert       => 'path/to/cert',
+      :ssl        => true # default is true
     }
 
 Initialize sms:
 
     sms = Mfms::SMS.new('phone','title','text') # initialize sms
 
-Send it and get sent sms id and dispatch code
+Send it and get sent sms id and dispatch code:
 
-    sms.send # send sms
+    sms.send # send sms. returns sms id or dispatch code if something went wrong
     sms.id # get sms id
-    sms.code # get sms dispatch code
+
+Get current sms status and update it:
+
+    sms.status # get sms delivery status
+    sms.update_status # updates sms delivery status. returns status or status check response code on error
+
+Get any sms status:
+
+    code, status = Mfms::SMS.status(sms_id) # code - response code can contain error description, status - sms delivery status if code is 'ok'
 
 Ex.:
 
     sms = Mfms::SMS.new('79031111111','MyFavouriteCompany','Testing mfms gem')
-    sms.send
+    sms.send # => 1032
     sms.id # => 1032
-    sms.code # => ok
 
 ## Contributing
 

data/lib/mfms/sms.rb

@@ -7,14 +7,13 @@ module Mfms
   class SMS
 
     attr_accessor :phone, :subject, :message
-    attr_reader :code, :id
+    attr_reader :id, :status
 
-    def initialize(phone, subject, message, ssl=true)
-      @port = ssl ? @@ssl_port : @@port
-      @ssl = ssl
+    def initialize(phone, subject, message)
       @phone = phone
       @subject = subject
       @message = message
+      @status = 'not-sent'
 
       validate!
     end
@@ -27,72 +26,68 @@ module Mfms
       @@ssl_port = settings[:ssl_port]
       @@cert_store = OpenSSL::X509::Store.new
       @@cert_store.add_cert OpenSSL::X509::Certificate.new File.read(settings[:cert])
+      @@ssl = settings[:ssl] & true # connect using ssl by default
 
       validate_settings!
     end
 
-    def ssl=(flag)
-      @port = flag ? @@ssl_port : @@port
-      @ssl = flag
+    def self.ssl=(flag)
+      @@ssl = flag
     end
 
+    def self.ssl
+      @@ssl
+    end
+
+    # => SMS send status codes:
+    #    "ok"                     "Сообщения приняты на отправку"
+    #    "error-system"           "При обработке данного сообщения произошла системная ошибка"
+    #    "error-address-format"   "Ошибка формата адреса"
+    #    "error-address-unknown"  "Отправка по данному направлению не разрешена"
+    #    "error-subject-format"   "Ошибка формата отправителя"
+    #    "error-subject-unknown"  "Данный отправителть не разрешен на нашей платформе"
+
     def send
       #return stubbed_send if (defined?(Rails) && !Rails.env.production?)
-
-      establish_connection(@ssl).start do |http|
+      self.class.establish_connection.start do |http|
         request = Net::HTTP::Get.new(send_url)
         response = http.request(request)
-        splitted_body = response.body.split(';')
-        @code = splitted_body[0]
-        @id = splitted_body[2]
-        # result = case res_code
-        #   when "ok" then "сообщения приняты на отправку"
-        #   when "error-system" then "при обработке данного сообщения произошла системная ошибка"
-        #   when "error-address-format" then "ошибка формата адреса"
-        #   when "error-address-unknown" then "отправка по данному направлению не разрешена"
-        #   when "error-subject-format" then "ошибка формата отправителя"
-        #   when "error-subject-unknown" then "данный отправителть не разрешен на нашей платформе"
-        # end
+        body = response.body.split(';')
+        return body[0] unless body[0] == 'ok'
+        @status = 'sent'
+        @id = body[2]
+      end
+    end
+    
+    # => SMS delivery status codes:
+    #    "enqueued"     "Сообщение находится в очереди на отправку"
+    #    "sent"         "Сообщение отправлено"
+    #    "delivered"    "Сообщение доставлено до абонента"
+    #    "undelivered"  "Сообщение недоставлено до абонента"
+    #    "failed"       "Сообщение недоставлено из-за ошибки на платформе"
+    #    "delayed"      "Было указано отложенное время отправки и сообщение ожидает его"
+    #    "cancelled"    "Сообщение было отменено вручную на нашей платформе"
+
+    # => SMS status check response codes:
+    #    "ok"                           "Запрос успешно обработан"
+    #    "error-system"                 "Произошла системная ошибка"
+    #    "error-provider-id-unknown"    "Сообщение с таким идентификатором не найдено"
+
+    def self.status(id)
+      establish_connection.start do |http|
+        request = Net::HTTP::Get.new(status_url id)
+        response = http.request(request)
+        body = response.body.split(';')
+        return body[0], body[2] # code, status
       end
     end
 
-    # Not used atm
-
-    # def self.status msg_id
-    #   puts "Сообщение присвоен ID:"
-    #   puts msg_id
-
-    #   connection = establish_connection(@ssl)
-    #   connection.start do |http|
-    #     request = Net::HTTP::Get.new(status_url msg_id)
-    #     response = http.request(request)
-    #     splitted_body = response.body.split(';')
-    #     res_code = splitted_body[0]
-    #     result = case res_code
-    #       when "ok" then "Запрос успешно обработан"
-    #       when "error-system" then "Произошла системная ошибка"
-    #       when "error-provider-id-unknown" then "Сообщение с таким идентификатором не найдено"
-    #     end
-    #     stat_code = splitted_body[2]
-    #     unless stat_code.nil?
-    #       @status = case stat_code
-    #         when "enqueued" then "сообщение находится в очереди на отправку"
-    #         when "sent" then "сообщение отправлено"
-    #         when "delivered" then "сообщение доставлено до абонента"
-    #         when "undelivered" then "сообщение недоставлено до абонента"
-    #         when "failed" then "сообщение недоставлено из-за ошибки на платформе"
-    #         when "delayed" then "было указано отложенное время отправки и сообщение ожидает его"
-    #         when "cancelled" then "сообщение было отменено вручную на нашей платформе"
-    #       end
-    #     end
-    #   end
-
-    #   if @status
-    #     @status
-    #   else
-    #     "ошибка"
-    #   end
-    # end 
+    def update_status
+      return @status if @id.nil?
+      code, status = self.class.status(@id)
+      return code unless code == 'ok'
+      @status = status
+    end
 
     # What for?
     # def to_json
@@ -101,35 +96,29 @@ module Mfms
 
     private
 
-    #def stubbed_send
-    #end
-
-    def establish_connection(ssl=true)
-      http = Net::HTTP.new(@@server, @port)
-      if ssl
+      def self.establish_connection
+        port = @@ssl ? @@ssl_port : @@port
+        http = Net::HTTP.new(@@server, port)
+        http.use_ssl = @@ssl
         http.cert_store = @@cert_store
-        http.use_ssl = true
+        http
       end
-      http
-    end
 
-    def validate! 
-    end
-
-    def self.validate_settings!
-    end
+      def validate!
+      end
 
-    def send_url
-      "/revoup/connector0/send?login=#{@@login}&password=#{@@password}&" +
-      "subject[0]=#{@subject}&address[0]=#{@phone}&text[0]=#{URI.encode(@message)}"
-    end
+      def self.validate_settings!
+      end
 
-    # Not used atm
+      def send_url
+        "/revoup/connector0/send?login=#{@@login}&password=#{@@password}&" +
+        "subject[0]=#{@subject}&address[0]=#{@phone}&text[0]=#{URI.encode(@message)}"
+      end
 
-    # def status_url msg_id
-    #   "/revoup/connector0/status?login=#{@@login}&password=#{@@password}&" +
-    #   "providerId[0]=#{msg_id}"
-    # end
+      def self.status_url msg_id
+        "/revoup/connector0/status?login=#{@@login}&password=#{@@password}&" +
+        "providerId[0]=#{msg_id}"
+      end
 
   end
 end

data/lib/mfms/version.rb

@@ -1,8 +1,8 @@
 module Mfms
   class Version
     MAJOR = 0
-    MINOR = 1
-    PATCH = 1
+    MINOR = 2
+    PATCH = 0
 
     def self.to_s
       "#{MAJOR}.#{MINOR}.#{PATCH}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mfms
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Fokin Eugene
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-01 00:00:00.000000000 Z
+date: 2013-03-04 00:00:00.000000000 Z
 dependencies: []
 description: This library helps to send sms via mfms service
 email: