brTerminacoes 0.0.2 → 0.0.3

data/README.rdoc

@@ -1,6 +1,6 @@
 = brTerminacoes
 
-Description goes here.
+Essa gem tem a finalidade de facilitar o desenvolvimento de aplicações ruby on rails que enviem SMS atráves do gateway brTerminações. Essa biblioteca é open source e a empresa brTerminações não tem nenhuma responsabilidade sobre seu conteúdo. Essa é uma iniciativa da lunaltas.com, empresa que apoia fortemente o desenvolvimento de software livre no Brasil, sendo ela a idealizadora desse projeto.
 
 == Contribuindo para brTerminacoes
 
@@ -11,7 +11,50 @@ Description goes here.
 * Commit e empurre até que você esteja satisfeito com sua contribuição
 * Certifique-se de adicionar testes para isso. Isto é importante para não quebrar a GEM em uma futura versão.
 
+== Utilizando brTerminacoes
+
+== Instalação
+
+Adicione ao seu Gemfile em seguida, executar +bundle+ para instalá-lo.
+
+  gem "brTerminacoes"
+
+== Instanciando
+
+Crie um objeto sms passando como parâmetro o usuário e senha da sua conta brTerminações (mesmo que seja conta teste).
+
+  sms = Sms.new(usuario, senha)
+
+== Enviando menssagem
+
+Após criar o objeto chame o método enviar passando os parametros necessários para o envio. Essa função retorna 'true' se a menssagem for enviada com sucesso.
+
+  sms.enviar(remetente, mensagem, numeros)
+
+onde:
+
+* remetente é uma string que indica quem envio o sms
+* menssagem é uma string com máximo de 130 caractéres com o conteúdo da menssagem
+* numeros é uma string com os números que receberão a mensagem. Ex: "1199889988,8488778877,2177999977"
+
+
+== Consultando Saldo
+
+Objeto instanciado possui um método saldo que retorna uma string contendo o numero de menssagem que podem ser enviadas e data da consulta.
+
+  sms.saldo()
+
+== Gerando relatórios
+
+Para criar relatórios dos sms dispardos utilize o método relatorio que retorna uma string contendo dados de todos as mensagens envidas em um determinado periodo.
+
+  sms.relatorio(data_inicial, data_final, modo)
+
+data_inicial: Data inicial do relatório. String no formato YYYY-MM-DD
+data_final: Data final do relatório. String no formato YYYY-MM-DD
+modo: se enviado "resume" :Relatório Resumido
+modo: se enviado "detail" :Relatório Detalhado
+
 == Copyright
 
-Copyright (c) 2012 Lunaltas. See LICENSE.txt for
-further details.
+Copyright (c) 2012 Lunaltas. Veja o arquivo LICENSE.txt para mais detalhes.

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/brTerminacoes.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "brTerminacoes"
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Tobias"]

data/lib/brTerminacoes.rb

@@ -17,8 +17,8 @@ class Sms
     conectar(@params)
   end
 
-  def enviar(from, mensagem, numeros)
-    @params = { :fuse => 'send_msg', :id => @id, :from => from, :msg => mensagem, :number => numeros }
+  def enviar(remetente, mensagem, numeros)
+    @params = { :fuse => 'send_msg', :id => @id, :from => remetente, :msg => mensagem, :number => numeros }
     conectar(@params)
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brTerminacoes
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-01-03 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &85489430 !ruby/object:Gem::Requirement
+  requirement: &77348520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *85489430
+  version_requirements: *77348520
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &85489190 !ruby/object:Gem::Requirement
+  requirement: &77348280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :development
   prerelease: false
-  version_requirements: *85489190
+  version_requirements: *77348280
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &85488950 !ruby/object:Gem::Requirement
+  requirement: &77348040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.6.4
   type: :development
   prerelease: false
-  version_requirements: *85488950
+  version_requirements: *77348040
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &85488710 !ruby/object:Gem::Requirement
+  requirement: &77347800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *85488710
+  version_requirements: *77347800
 description: gem para envio de sms através da brTerminações
 email: tiagotobias2003@gmail.com
 executables: []
@@ -89,7 +89,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -354816593
+      hash: -913035665
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: