Permalink
Browse files

Merge remote branch 'rafael/refactor_client' into rafael_refactor

  • Loading branch information...
herberthamaral committed Nov 15, 2010
2 parents 7256c1f + 138227d commit da72295c2d32a67c49f5f4db536b8fb53a3c3ebd
Showing with 394 additions and 263 deletions.
  1. +1 −1 .gitignore
  2. +4 −0 Gemfile
  3. +35 −0 Gemfile.lock
  4. +38 −42 README.markdown
  5. +11 −24 Rakefile
  6. +34 −48 lib/moip.rb
  7. +59 −0 lib/moip/client.rb
  8. +4 −1 lib/{ → moip}/direct_payment.rb
  9. +17 −4 moip.gemspec
  10. +0 −143 spec/lib/moip_spec.rb
  11. +191 −0 spec/moip_spec.rb
View
@@ -17,9 +17,9 @@ tmtags
coverage
rdoc
pkg
+.bundle
## PROJECT::SPECIFIC
-
lib/main.rb
config.yaml
config/
View
@@ -0,0 +1,4 @@
+# A sample Gemfile
+source "http://rubygems.org"
+
+gemspec
View
@@ -0,0 +1,35 @@
+PATH
+ remote: .
+ specs:
+ moip (1.0.1)
+ activesupport (>= 2.3.2)
+ httparty (~> 0.6.1)
+ nokogiri (~> 1.4.3)
+
+GEM
+ remote: http://rubygems.org/
+ specs:
+ activesupport (3.0.1)
+ crack (0.1.8)
+ diff-lcs (1.1.2)
+ httparty (0.6.1)
+ crack (= 0.1.8)
+ nokogiri (1.4.3.1)
+ rspec (2.1.0)
+ rspec-core (~> 2.1.0)
+ rspec-expectations (~> 2.1.0)
+ rspec-mocks (~> 2.1.0)
+ rspec-core (2.1.0)
+ rspec-expectations (2.1.0)
+ diff-lcs (~> 1.1.2)
+ rspec-mocks (2.1.0)
+
+PLATFORMS
+ ruby
+
+DEPENDENCIES
+ activesupport (>= 2.3.2)
+ httparty (~> 0.6.1)
+ moip!
+ nokogiri (~> 1.4.3)
+ rspec (~> 2.1.0)
View
@@ -7,7 +7,7 @@ Esta Gem permite utilizar a API do MoIP, gateway de pagamentos do IG.
O Pagamento Direto é um recurso que a MoIP disponibiliza para aqueles clientes que necessitam de uma flexibilidade maior do que a Integração HTML pode oferecer.
Diferentemente de como é feito com a Integração HTML, seu cliente não precisa ser redirecionado para o site da MoIP para concluir a compra: tudo é feito dentro do ambiente do seu site, dando ao cliente uma maior segurança e confiança no processo.
-
+
As formas de pagamento disponibilizadas pela Gem são:
* Boleto
@@ -17,68 +17,64 @@ As formas de pagamento disponibilizadas pela Gem são:
## Instalação
Instale a Gem
- gem install moip
+ gem install moip
Adicione a Gem ao Gemfile
- gem "moip"
+ gem "moip"
## Utilização
-O MoIP possui uma SandBox de testes que permite a simulação de pagamentos. Para utilizar a Gem com o SandBox, crie o arquivo moip.yml na pasta config do seu projeto Rails e adicione o token e chave do MoIP.
-
-## moip.yml
+O MoIP possui uma SandBox de testes que permite a simulação de pagamentos. Para utilizar a Gem com o SandBox, adicione a seguinte configuração no arquivo do environment que deseja utilizar.
- development:
- uri: https://desenvolvedor.moip.com.br/sandbox
- token: SEU_TOKEN
- key: SUA_KEY
+### config/environments/development.rb
- production:
- uri:
- token:
- key:
+ MoIP.setup do |config|
+ config.uri = https://desenvolvedor.moip.com.br/sandbox
+ config.token = SEU_TOKEN
+ config.key = SUA_KEY
+ end
-Após realizar os testes na SandBox, você poderá fazer a mudança para o ambiente de produção do MoIP de maneira simples. Basta inserir o token e chave de produção no arquivo moip.yml.
+Após realizar os testes na SandBox, você poderá fazer a mudança para o ambiente de produção do MoIP de maneira simples. Basta inserir no arquivo de environment de produção o token e chave que serão utilizados. Por padrão a gem já utiliza a URI de produção do MoIP.
###Crie os dados do pagador
- pagador = { :nome => "Luiz Inácio Lula da Silva",
- :login_moip => "lula",
- :email => "presidente@planalto.gov.br",
- :tel_cel => "(61)9999-9999",
- :apelido => "Lula",
- :identidade => "111.111.111-11",
- :logradouro => "Praça dos Três Poderes",
- :numero => "0",
- :complemento => "Palácio do Planalto",
- :bairro => "Zona Cívico-Administrativa",
- :cidade => "Brasília",
- :estado => "DF",
- :pais => "BRA",
- :cep => "70100-000",
- :tel_fixo => "(61)3211-1221" }
+ pagador = { :nome => "Luiz Inácio Lula da Silva",
+ :login_moip => "lula",
+ :email => "presidente@planalto.gov.br",
+ :tel_cel => "(61)9999-9999",
+ :apelido => "Lula",
+ :identidade => "111.111.111-11",
+ :logradouro => "Praça dos Três Poderes",
+ :numero => "0",
+ :complemento => "Palácio do Planalto",
+ :bairro => "Zona Cívico-Administrativa",
+ :cidade => "Brasília",
+ :estado => "DF",
+ :pais => "BRA",
+ :cep => "70100-000",
+ :tel_fixo => "(61)3211-1221" }
###Dados do boleto
- boleto = { :valor => "50",
- :id_proprio => "Pag#{rand(1000)}",
- :forma => "BoletoBancario",
- :dias_expiracao => 5,
- :pagador => pagador }
+ boleto = { :valor => "50",
+ :id_proprio => "Pag#{rand(1000)}",
+ :forma => "BoletoBancario",
+ :dias_expiracao => 5,
+ :pagador => pagador }
###Checkout
- def checkout
- response = MoIP.checkout(boleto)
+ def checkout
+ response = MoIP::Client.checkout(boleto)
- # exibe o boleto para impressão
- redirect_to MoIP.moip_page(response["Token"])
- end
+ # exibe o boleto para impressão
+ redirect_to MoIP::Client.moip_page(response["Token"])
+ end
-### Futuras implementações
+## Futuras implementações
* Pagamento Simples
* Pagamento Recorrente
-Baseado no projeto do [Daniel Lopes](http://github.com/danielvlopes/moip_usage).
+Baseado no projeto do [Daniel Lopes](http://github.com/danielvlopes/moip_usage).
View
@@ -6,42 +6,29 @@ begin
require 'jeweler'
Jeweler::Tasks.new do |gem|
gem.name = "moip"
- gem.summary = %Q{Gem para utilização da API MoIP}
- gem.description = %Q{Gem para utilização da API MoIP}
+ gem.summary = "Gem para utilização da API MoIP"
+ gem.description = "Gem para utilização da API MoIP"
gem.email = "guilherme.ruby@gmail.com"
gem.homepage = "http://github.com/guinascimento/moip"
gem.authors = ["Guilherme Nascimento"]
-# gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
- # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+ gem.add_development_dependency "rspec", "~> 2.1.0"
+ gem.add_dependency "nokogiri", "~> 1.4.3"
+ gem.add_dependency "httparty", "~> 0.6.1"
+ gem.add_dependency "activesupport", '>= 2.3.2'
end
Jeweler::GemcutterTasks.new
rescue LoadError
puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
end
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
- test.libs << 'lib' << 'test'
- test.pattern = 'test/**/test_*.rb'
- test.verbose = true
-end
+require 'rspec/core/rake_task'
-begin
- require 'rcov/rcovtask'
- Rcov::RcovTask.new do |test|
- test.libs << 'test'
- test.pattern = 'test/**/test_*.rb'
- test.verbose = true
- end
-rescue LoadError
- task :rcov do
- abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
- end
-end
+desc "Run all examples"
+RSpec::Core::RakeTask.new
-task :test => :check_dependencies
+task :spec => :check_dependencies
-task :default => :test
+task :default => :spec
require 'rake/rdoctask'
Rake::RDocTask.new do |rdoc|
View
@@ -1,61 +1,47 @@
+# encoding: utf-8
require "rubygems"
-require 'httparty'
-require "nokogiri"
-
-require "direct_payment"
+require 'active_support/core_ext/module/attribute_accessors'
+require 'active_support/deprecation'
module MoIP
- include HTTParty
-
- CONFIG = YAML.load_file("config/moip.yml")["development"]
- STATUS = { 1 => "authorized", 2 => "started", 3 => "printed", 4 => "completed", 5 => "canceled", 6 => "analysing"}
-
- base_uri "#{CONFIG["uri"]}/ws/alpha"
- basic_auth CONFIG["token"], CONFIG["key"]
-
- class << self
-
- # Envia uma instrução para pagamento único
- def checkout(attributes = {})
- full_data = post('EnviarInstrucao/Unica', :body => DirectPayment.body(attributes))
+ autoload :DirectPayment, 'moip/direct_payment'
+ autoload :Client, 'moip/client'
- raise(StandardError, "Ocorreu um erro ao chamar o webservice") if full_data.nil?
+ # URI para acessar o serviço
+ mattr_accessor :uri
+ @@uri = 'https://www.moip.com.br'
- response = full_data["ns1:EnviarInstrucaoUnicaResponse"]["Resposta"]
- raise(StandardError, response["Erro"]) if response["Status"] == "Falha"
+ # Token de autenticação
+ mattr_accessor :token
- return response
- end
+ # Chave de acesso ao serviço
+ mattr_accessor :key
- # Consulta dos dados das autorizações e pagamentos associados à Instrução
- def query(token)
- full_data = get("ConsultarInstrucao/#{token}")
- raise(StandardError, "Ocorreu um erro ao chamar o webservice") if full_data.nil?
+ def self.setup
+ yield self
+ end
- response = full_data["ns1:ConsultarTokenResponse"]["RespostaConsultar"]
- raise(StandardError, response["Erro"]) if response["Status"] == "Falha"
+ STATUS = {1 => "authorized", 2 => "started", 3 => "printed", 4 => "completed", 5 => "canceled", 6 => "analysing"}
- return response
- end
-
- # Retorna a URL de acesso ao MoIP
- def moip_page(token)
- raise(StandardError, "É necessário informar um token para retornar os dados da transação") if token.nil?
- "#{CONFIG["uri"]}/Instrucao.do?token=#{token}"
- end
+ class << self
+ def checkout(attributes = {})
+ ActiveSupport::Deprecation.warn("MoIP.checkout has been deprecated. Use MoIP::Client.checkout instead", caller)
+ MoIP::Client.checkout(attributes)
+ end
- # Monta o NASP
- def notification(params)
- notification = {}
- notification[:transaction_id] = params["id_transacao"]
- notification[:amount] = params["valor"]
- notification[:status] = STATUS[params["status_pagamento"].to_i]
- notification[:code] = params["cod_moip"]
- notification[:payment_type] = params["tipo_pagamento"]
- notification[:email] = params["email_consumidor"]
- notification
- end
+ def query(token)
+ ActiveSupport::Deprecation.warn("MoIP.query has been deprecated. Use MoIP::Client.query instead", caller)
+ MoIP::Client.query(token)
+ end
+ def moip_page(token)
+ ActiveSupport::Deprecation.warn("MoIP.moip_page has been deprecated. use MoIP::Client.moip_page instead", caller)
+ MoIP::Client.moip_page(token)
end
-end
+ def notification(params)
+ ActiveSupport::Deprecation.warn("MoIP.notification has been deprecated. use MoIP::Client.notification instead", caller)
+ MoIP::Client.moip_page(token)
+ end
+ end
+end
View
@@ -0,0 +1,59 @@
+# encoding: utf-8
+require 'httparty'
+
+module MoIP
+ class Client
+ include HTTParty
+
+ base_uri "#{MoIP.uri}/ws/alpha"
+ basic_auth MoIP.token, MoIP.key
+
+ class << self
+
+ # Envia uma instrução para pagamento único
+ def checkout(attributes = {})
+ full_data = peform_action!(:post, 'EnviarInstrucao/Unica', :body => DirectPayment.body(attributes))
+
+ get_response!(full_data["ns1:EnviarInstrucaoUnicaResponse"]["Resposta"])
+ end
+
+ # Consulta dos dados das autorizações e pagamentos associados à Instrução
+ def query(token)
+ full_data = peform_action!(:get, "ConsultarInstrucao/#{token}")
+
+ get_response!(full_data["ns1:ConsultarTokenResponse"]["RespostaConsultar"])
+ end
+
+ # Retorna a URL de acesso ao MoIP
+ def moip_page(token)
+ raise(StandardError, "É necessário informar um token para retornar os dados da transação") if token.nil?
+ "#{MoIP.uri}/Instrucao.do?token=#{token}"
+ end
+
+ # Monta o NASP
+ def notification(params)
+ notification = {}
+ notification[:transaction_id] = params["id_transacao"]
+ notification[:amount] = params["valor"]
+ notification[:status] = MoIP::STATUS[params["status_pagamento"].to_i]
+ notification[:code] = params["cod_moip"]
+ notification[:payment_type] = params["tipo_pagamento"]
+ notification[:email] = params["email_consumidor"]
+ notification
+ end
+
+ private
+
+ def peform_action!(action_name, url, options = {})
+ response = self.send(action_name, url, options)
+ raise(StandardError, "Ocorreu um erro ao chamar o webservice") if response.nil?
+ response
+ end
+
+ def get_response!(data)
+ raise(StandardError, data["Erro"]) if data["Status"] == "Falha"
+ data
+ end
+ end
+ end
+end
@@ -1,3 +1,6 @@
+# encoding: utf-8
+require "nokogiri"
+
module MoIP
class DirectPayment
@@ -127,4 +130,4 @@ def body(attributes = {})
end
-end
+end
Oops, something went wrong.

0 comments on commit da72295

Please sign in to comment.