mobilepronto 0.1.0

data/README.md

@@ -0,0 +1,72 @@
+# What is it?
+
+A Ruby interface to the [MobilePronto](http://www.mobilepronto.org/) SMS gateway API.
+Please note: this gem is a proxy to MobiePronto SMS gateway, to use it you should get your credentials with the service of [MobilePronto](http://www.mobilepronto.org/), not responsible at any time by the service offered by [MobilePronto](http://www.mobilepronto.org/).
+
+# Installation
+
+Download [the latest version of gem](http://rubygems.org/gems/mobilepronto) or install using RubyGems.
+
+```shell
+$ sudo gem install mobilepronto
+```
+
+## MobilePronto on GitHub
+
+```shell
+$ git clone git://github.com/nuxlli/mobilepronto.git
+```
+
+# Basic Usage
+
+To use this gem, you will need sign up for an account at the [MobilePronto](http://www.mobilepronto.org/) website. 
+Once you are registered and logged into your account centre, you should add 
+an HTTP API connection to your account. This will give you your CREDENCIAL.
+
+## Demonstration
+### EnviaSMS
+
+```ruby
+require 'mobilepronto'
+
+# Configure default values
+MobilePronto.configure do |config|
+  # Default api url
+  # config.url_api = "http://www.mpgateway.com/v_2_00/smspush/enviasms.aspx"
+  
+  config.credential   = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
+  config.project_name = "MYPROJECT"
+  config.send_project = true
+end
+
+sms = {
+  :mobile    => 552199999999,
+  :user_name => "MYUSER",
+  :message   => "Mensagem de test"
+}
+
+# Using blocks to analyze the result
+MobilePronto.send_sms(sms) do |result|
+  result.on(:ok) { puts "Mensagem sendend..." }
+  result.on(1..999) { puts "Ops: #{result.error.message}"}
+end
+
+# Or begin/rescue
+begin
+  MobilePronto.send_sms(sms)
+rescue MobilePronto::SendError => e
+  puts "Ops: #{e.message}"
+end
+
+```
+
+# References
+
+http://www.mobilepronto.info/samples/en-US/1205-httpget-php-v_2_00.pdf
+
+# License
+
+MobilePronto is licensed under the [BSD License](http://opensource.org/licenses/BSD-2-Clause).
+
+See LICENSE file for details.
+

data/lib/mobilepronto/basic.rb

@@ -0,0 +1,53 @@
+# encoding: UTF-8
+require 'active_support/configurable'
+
+class MobilePronto
+  module Basic
+    def self.extended(base)
+      base.send(:include, ActiveSupport::Configurable)
+    end
+
+    def send_msg(options = {}, &block)
+      request(options.merge(config), &block)
+    end
+
+    private
+
+    def request(params)
+      query     = build_query(params)
+      uri       = URI.parse(config.url_api)
+      uri.query = query != "" ? query : nil
+      http      = Net::HTTP.new(uri.host, uri.port)
+      request   = Net::HTTP::Get.new(uri.request_uri)
+      response  = http.request(request)
+      if (response.body != "000")
+        error = SendError.new(response.body)
+        block_given? ? yield(Result.new(response.body, error)) : raise(error)
+      else
+        block_given? ? yield(Result.new(:ok)) : :ok
+      end
+    end
+
+    def build_query(params)
+      keys = {
+        :credencial   => 'CREDENCIAL',
+        :project_name => 'PRINCIPAL_USER',
+        :user_name    => 'AUX_USER',
+        :mobile       => 'MOBILE',
+        :send_project => 'SEND_PROJECT',
+        :message      => 'MESSAGE'
+      }
+
+      params = params.inject({}) do |options, (key, value)|
+        options[(key.to_sym rescue key) || key] = value
+        options
+      end
+
+      unless params[:send_project].nil?
+        params[:send_project] = params[:send_project] ? 'S' : 'N'
+      end
+
+      params.map { |k, v| keys.key?(k) ? "#{keys[k]}=#{URI.escape(v.to_s)}" : nil }.compact.join("&")
+    end
+  end
+end

data/lib/mobilepronto/errors.rb

@@ -0,0 +1,49 @@
+# encoding: UTF-8
+
+class MobilePronto
+  class SendError < Exception
+    attr_accessor :code
+
+    # X01 ou X02 – Parâmetros com Erro. 
+    # 000 - Mensagem enviada com Sucesso.
+    # 001 - Credencial Inválida. 
+    # 005 - Mobile fora do formato-Formato +999(9999)99999999
+    # 007 - SEND_PROJECT tem que ser S,
+    # 008 - Mensagem ou FROM+MESSAGE maior que 142 posições
+    # 009 - Sem crédito para envio de SMS. Favor repor
+    # 010 - Gateway Bloqueado. 
+    # 012 - Mobile no formato padrão, mas incorreto
+    # 013 - Mensagem Vazia ou Corpo Inválido
+    # 015 - Pais sem operação. 
+    # 016 - Mobile com tamanho do código de área inválido
+    # 017 - Operadora não autorizada para esta Credencial
+    # De 800 a 899 - Falha no gateway Mobile Pronto
+    # 900 - Erro de autenticação ou Limite de segurança 
+    # De 901 a 999 - Erro no acesso as operadoras.
+    def initialize(code)
+      self.code = code.strip
+      if (code == "X01" || code == "X02")
+        msg = "Parâmetros com Erro."
+      else 
+        msg = case(code.to_i)
+          when   1 then "Credencial Inválida."
+          when   5 then "Mobile fora do formato-Formato +999(9999)99999999."
+          when   7 then "SEND_PROJECT tem que ser S ou N"
+          when   8 then "Mensagem ou FROM+MESSAGE maior que 142 posições."
+          when   9 then "Sem crédito para envio de SMS."
+          when  10 then "Gateway Bloqueado."
+          when  12 then "Mobile no formato padrão, mas incorreto."
+          when  13 then "Mensagem Vazia ou Corpo Inválido."
+          when  15 then "Pais sem operação."
+          when  16 then "Mobile com tamanho do código de área inválido."
+          when  17 then "Operadora não autorizada para esta Credencial."
+          when 900 then "Erro de autenticação ou Limite de segurança"
+          when 800..899 then "Falha no gateway Mobile Pronto"
+          when 901..999 then "Erro no acesso as operadoras."
+        end
+      end
+      
+      super("#{self.code} - #{msg}")
+    end
+  end
+end

data/lib/mobilepronto/result.rb

@@ -0,0 +1,28 @@
+# encoding: UTF-8
+
+class MobilePronto
+  class Result
+    attr_reader :code
+    attr_reader :error
+
+    def initialize(code, error = nil)
+      @code  = ["X01", "X02", :ok].include?(code) ? code : code.to_i
+      @error = error
+    end
+
+    def on(*args)
+      if block_given? and
+         args.any? { |i| i.kind_of?(Range) ? i.include?(code) : i == code }
+        yield
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      if block_given? && !(code = /on_([0-9]*)/.match(method)).nil?
+        self.on(code[1].to_i, &block)
+      else
+        super(method, *args, &block)
+      end
+    end
+  end
+end

data/lib/mobilepronto/version.rb

@@ -0,0 +1,26 @@
+# encoding: UTF-8
+
+begin
+  require "step-up"
+rescue Exception => e; end
+
+class MobilePronto
+  module VERSION #:nodoc:
+    pwd = ::File.expand_path(::File.dirname(__FILE__))
+    version = nil
+    version = $1 if ::File.join(pwd, '../..') =~ /\/mobilepronto-(\d[\w\.]+)/
+    version_file = ::File.join(pwd, '../../GEM_VERSION')
+    version = File.read(version_file) if version.nil? && ::File.exists?(version_file)
+    if version.nil? && ::File.exists?(::File.join(pwd, '/../../.git'))
+      version = ::StepUp::Driver::Git.new.last_version_tag("HEAD", true) rescue "v0.0.0+0"
+      ::File.open(version_file, "w"){ |f| f.write version }
+    end
+
+    STRING = version.gsub(/^v?([^\+]+)\+?\d*$/, '\1')
+    MAJOR, MINOR, PATCH, TINY = STRING.scan(/\d+/)
+
+    def self.to_s
+      STRING
+    end
+  end
+end

data/lib/mobilepronto.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__))
+
+# Dependencies
+require "rubygems"
+require "net/http"
+require "uri"
+
+require File.dirname(__FILE__) + '/mobilepronto/version'
+require File.dirname(__FILE__) + '/mobilepronto/errors'
+require File.dirname(__FILE__) + '/mobilepronto/result'
+require File.dirname(__FILE__) + '/mobilepronto/basic'
+
+class MobilePronto
+  extend Basic
+  # autoload :AClass , "migrator/a_class"
+end
+
+# Default configuration
+MobilePronto.configure do |config|
+  config.url_api      = "http://www.mpgateway.com/v_2_00/smspush/enviasms.aspx"
+  config.send_project = false
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: mobilepronto
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Éverton A. Ribeiro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-16 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70139252945720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70139252945720
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70139252944880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70139252944880
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70139252936920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70139252936920
+- !ruby/object:Gem::Dependency
+  name: step-up
+  requirement: &70139252936220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: *70139252936220
+description: 
+email: nuxlli@gmail.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mobilepronto/basic.rb
+- lib/mobilepronto/errors.rb
+- lib/mobilepronto/result.rb
+- lib/mobilepronto/version.rb
+- lib/mobilepronto.rb
+- README.md
+homepage: http://github.com/nuxlli/mobilepronto
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: A Ruby interface to the MobilePronto SMS gateway API.
+test_files: []