zenvia-rb 0.0.11 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e3ab5173226fc04888992fcca4b1e6d1574397e4
-  data.tar.gz: b58eac4d7450a00d96e9697537c64f29959ca70f
+  metadata.gz: ec6c97be083c4b8465171a3451f5b7f44c838843
+  data.tar.gz: 565b1aa8d3f4297eeff2a31d7947169d45866443
 SHA512:
-  metadata.gz: 7a3dc3703550712a289e349f13fd2121285c4fa37c30b008487d8cb1a3abbcde2fdc48f6f71c9c2d6f392cd782d157b3a787d7a1e96e826409cd7054e633472c
-  data.tar.gz: fd3d735994f2ed28159afba88f475c9f2c87d75c65be6ee1d97296eb61fe04d88616c25966a189f707a58236999c2e277649b6211dc3c48ffa9fbeb442f29984
+  metadata.gz: 85cebd704334b96716482e0aeaa5f2487b21a78a4f8f2573b3de5b8dc7c305e94ef41e5adaee5e0d149f8d8e3ac14924d781dfc095dde02836af60627132c73e
+  data.tar.gz: 1e94b925c75f59a863bf8e9572b64649918d2b95f0c3eece6040ed73b048591b269f4202258acdf1dcba91713fb50b52fe0dd007e51d867a31865eb8119d4f52

data/README.md

@@ -1,61 +1,107 @@
 # Zenvia
 
-## Installation
+Esta biblioteca -**não oficial**- segue as diretivas da [documentação API REST da Zenvia](http://docs.zenviasms.apiary.io/#introduction/autenticacao). 
 
-Add this line to your application's Gemfile:
+## Instalação
+
+Adicione esta linha ao seu Gemfile
 
 ```ruby
-gem 'zenvia-rb', '~> 0.0.11'
+gem 'zenvia-rb', '~> 0.1.0'
 ```
 
-And then execute:
+E depois execute:
 
     $ bundle
 
-Or install it yourself as:
+Ou instale através do "gem install":
 
     $ gem install zenvia-rb
 
-HTTParty is the only dependency for this gem.
+A única dependência desta Gem é o HTTParty.
 
-## Usage
+## Uso
 
-In your script
+Para usar esta biblioteca, [você vai precisar informar alguns dados](http://docs.zenviasms.apiary.io/#introduction/autenticacao), que são obtidos através da própria Zenvia.
 
 ```ruby
 require 'zenvia'
+  
 
 Zenvia.configure {|config|
-    config.account = account_given_by_zenvia
-    config.code = code_given_by_zenvia
-    config.from = user_or_enterprise_name # optional
+    config.account = 'SUA-CONTA'
+    config.code = 'SEU-CODIGO'
+    config.from = 'NOME-DA-EMPRESA-OU-PESSOA' # opcional
 }
+```
+*Se você pretende usar esta Gem com Rails, insira o snippet acima em config/initializers.*
 
-# from = personal or enterprise name. config.from is used as default.
-# if you do not want to identify the sender, use from = ''
-# number = area code + number / there's no need to put 55 before them
-# AND format the number (i.e. remove parentheses, dashes...)
-# message = body of the message
+Feito isso, [para enviar uma mensagem](http://docs.zenviasms.apiary.io/#reference/servicos-da-api/envio-de-um-unico-sms/testar-envio-de-um-unico-sms), será preciso apenas chamar a função "send_message":
 
-Zenvia.send_message(number, message, from = config.from)
+```ruby
+options = {from: config.from, id: 'SEU-ID', schedule: '2017-07-18T02:01:23'}
+Zenvia.send_message(number, message, options)
+  
+# no hash 'options', você ainda pode inserir o aggregateId. Todos esses valores são opcionais  
+ 
+# Exemplo de resposta:
+{"sendSmsResponse"=>{"statusCode"=>"00", "statusDescription"=>"Ok", "detailCode"=>"000", "detailDescription"=>"Message Sent"}}
+```
 
-# alternatively, you can set number parameter equal to an array of numbers
-# and send the same message to them
-numbers = ['DDNNNNNNNNN', 'DDNNNNNNNNM']
-Zenvia.send_message(numbers, message, from = config.from)
+Se preferir, você pode definir um array de números e enviar a **mesma** mensagem a eles:
 
-```
+```ruby
 
-That's all ;)
+numbers = ['DDNNNNNNNNN', 'DDNNNNNNNNM']
+Zenvia.send_message(numbers, message)
+  
+
+# Exemplo de resposta
+ 
+[
+  {"sendSmsResponse"=>{"statusCode"=>"00", "statusDescription"=>"Ok", "detailCode"=>"000", "detailDescription"=>"Message Sent"}}, 
+  {"sendSmsResponse"=>{"statusCode"=>"00", "statusDescription"=>"Ok", "detailCode"=>"000", "detailDescription"=>"Message Sent"}}
+]
+```
 
-## Development
+Ou usar a função nativa do Zenvia, [de enviar múltiplos SMSs](http://docs.zenviasms.apiary.io/#reference/servicos-da-api/envio-de-varios-smss-simultaneamente/testar-envio-de-varios-smss-simultaneamente):
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+list = [
+ {
+   from: "remetente",
+   to: "555192551015",
+   msg: "uma mensagem",
+   callbackOption: "NONE"
+ },
+ {
+   from: "remetente",
+   to: "555199668010",
+   schedule: "2014-07-18T02:01:23",
+   msg: "outra mensagem",
+   callbackOption: "NONE",
+   id: "004"
+ }
+]  
+  
+
+Zenvia.send_multiple_messages list
+```
 
-## Contributing
+Caso tenha definido o ID no envio de uma mensagem, poderá buscar seu status chamando a função "lookup":
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/jefersonhuan/zenvia-rb
+```ruby
+id = 'SEU-ID'  
+    
+Zenvia.lookup(id)
+      
+
+# Exemplo de resposta 
+    
+{"sendSmsResponse": {"statusCode": "00", "statusDescription": "Ok", "detailCode": "000", "detailDescription": "Message Sent" }}
+```
 
+Isso é tudo, pessoal!
 
 ## License
 

data/lib/zenvia.rb

@@ -14,7 +14,15 @@ module Zenvia
   end
 
   # alias for Zenvia::SMS.send_message(*args)
-  def self.send_message(number, message, from = nil)
-    SMS.send_message number, message, from
+  def self.send_message(number, message, options = {})
+    SMS.send_message number, message, options
+  end
+
+  def self.send_multiple_messages(list = [])
+    SMS.send_multiple_messages list
+  end
+
+  def self.lookup(id)
+    SMS.lookup id
   end
 end

data/lib/zenvia/sms.rb

@@ -4,54 +4,126 @@ require 'timeout'
 
 module Zenvia
   class SMS
-    attr_writer :from, :number, :message
+    
+    def self.lookup(id)
+      begin
+        res = self.get_status id
+        JSON.parse res.body
+      rescue => e
+        puts "Error!\n#{e}"
+      end
+    end
 
     # function to send the message
-    def self.send_message(number, message, from = nil)
+    def self.send_message(number, message, options = {})
       begin
-        @from = from.nil? ? Zenvia.config.from : from
+        @responses = []
+        @from = options[:from].nil? ? Zenvia.config.from : options[:from]
         @message = message
-        # create numbers array and push onto it number(s) from parameters
+        @options = options
         numbers = number.is_a?(Array) ? number : number.split
+
         numbers.each do |nb|
           @number = nb
-          response = self.send_sms
-          response = JSON.parse(response.body)
-          puts "Response for #{nb}: #{response['sendSmsResponse']['detailDescription']}"
+          response = self.send_one_request
+          @responses.push JSON.parse(response.body)
+        end
+
+        treat_response
+      rescue => e
+        puts "Error!\n#{e}"
+      end
+    end
+
+    def self.send_multiple_messages(list = [], aggregate_id = nil)
+      begin
+        @list = list
+        @aggregate_id = aggregate_id
+        validate_list!
+
+        if @errors[:errors].empty?
+          response = self.send_multiple_requests
+          JSON.parse response.body
+        else
+          @errors
         end
       rescue => e
-        puts 'Error!'
-        raise e
+        puts "Error!\n#{e}"
       end
     end
 
     private
-    def self.send_sms
-      # convert number to string (if isn't yet) and insert the country code (standard: BR, 55)
-      # if not found
-      @number = @number.to_s unless @number.is_a? String
-      patterns = ['(', ')', ' ', '-']
-      patterns.each {|p| @number = @number.gsub(p, '')}
-      @number.insert(0, '55') unless /^55/.match(@number)
-      puts "THE NUMBER: #{@number}"
-      # retrieve auth value set in Config class
-      @auth = Zenvia.config.auth
-      endpoint = 'https://api-rest.zenvia360.com.br/services/send-sms'
-      HTTParty.post(endpoint,
-        body: {
-            sendSmsRequest: {
-                from: @from,
-                to: @number,
-                msg: @message,
-                callbackOption: 'NONE'
+      def self.send_one_request
+        @number = treat_number @number
+        endpoint = 'https://api-rest.zenvia360.com.br/services/send-sms'
+        HTTParty.post(endpoint,
+          body: {
+              sendSmsRequest: {
+                  from: @from,
+                  to: @number,
+                  msg: @message,
+                  id: @options[:id],
+                  schedule: @options[:schedule],
+                  aggregateId: @options[:aggregate_id],
+                  callbackOption: 'NONE'
+              }
+          }.to_json,
+          headers: self.headers
+        )
+      end
+
+      def self.send_multiple_requests
+        endpoint = 'https://api-rest.zenvia360.com.br/services/send-sms-multiple'
+        HTTParty.post(endpoint,
+          body: {
+              sendSmsMultiRequest: {
+                aggregateId: @aggregate_id,
+                sendSmsRequestList: @list
             }
-        }.to_json,
-        headers: {
+          }.to_json,
+          headers: self.headers
+        )
+      end
+
+      def self.get_status(id)
+        endpoint = "https://api-rest.zenvia360.com.br/services/get-sms-status/#{id}"
+        HTTParty.get(endpoint, headers: {
+            'Authorization' => "Basic #{Zenvia.config.auth}"
+          }
+        )
+      end
+
+      def self.treat_number(number)
+        number = number.to_s unless number.is_a? String
+        patterns = ['(', ')', ' ', '-']
+        patterns.each {|p| number = number.gsub(p, '')}
+        number.insert(0, '55') unless /^55/.match(number)
+        number
+      end
+
+      def self.validate_list!
+        @errors = {errors: []}
+
+        @list.each do |data|
+          @list[@list.index(data)][:to] = treat_number data[:to]
+
+          @errors[:errors].push to: 'required' unless data.include?(:to)
+          @errors[:errors].push msg: 'required' unless data.include?(:msg)
+
+          break if @errors[:errors].any?
+        end
+      end
+
+      def self.treat_response
+        @responses.count == 1 ? @responses.first : @responses
+      end
+
+      def self.headers
+        {
             'Content-Type' => 'application/json',
-            'Authorization' => "Basic #{@auth}",
+            'Authorization' => "Basic #{Zenvia.config.auth}",
             'Accept' => 'application/json'
         }
-      )
-    end
+      end
   end
 end

data/lib/zenvia/version.rb

@@ -1,3 +1,3 @@
 module Zenvia
-  VERSION = "0.0.11"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zenvia-rb
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.1.0
 platform: ruby
 authors:
 - Jeferson Huan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-18 00:00:00.000000000 Z
+date: 2017-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler