pagseguro_client 0.1.1 → 0.2.0

data/README.markdown

@@ -3,6 +3,8 @@
 Este é um plugin do Ruby on Rails que permite utilizar o [PagSeguro](https://pagseguro.uol.com.br), gateway de pagamentos do [UOL](http://uol.com.br).
 
 ## Changelog
+* Adicionado gerador para instalação da biblioteca em projetos Rails
+* Adicionada opção para URL de retorno dinâmica
 * Implementação parcial da [API de pagamentos](https://pagseguro.uol.com.br/v2/guia-de-integracao/api-de-pagamentos.html)
 * Implementação parcial da [API de notificações](https://pagseguro.uol.com.br/v2/guia-de-integracao/notificacoes.html)
 
@@ -13,17 +15,22 @@ Este é um plugin do Ruby on Rails que permite utilizar o [PagSeguro](https://pa
 Adicione a biblioteca ao arquivo Gemfile:
 
 ```ruby
-gem 'pagseguro_client', git: "git://github.com/matheustardivo/pagseguro_client.git"
+gem 'pagseguro_client', git: "git://github.com/fknappe/pagseguro_client.git"
 ```
 
-E crie o arquivo de configuração em `config/pagseguro.yml`:
+Depois de realizar a instalação da biblioteca, você precisará gerar o arquivo de configuração, que deve residir em config/pagseguro.yml. Para gerar o arquivo a partir de um modelo execute
+
+      rails generate pagseguro_client:install
+
+O arquivo de configuração gerado será parecido com isso: 
 
 ```yaml
 development: &development
   ws_url: "http://localhost:4000"
   ps_url: "http://localhost:4000"
+  return_to: "http://localhost:4000/successo"
   email: matheustardivo@gmail.com
-  token: "a1951ac04115012fabb660334b97cc6e"
+  token: "tokenGeradoPeloPagseguro"
 
 test:
   <<: *development
@@ -31,11 +38,12 @@ test:
 production:
   ws_url: "https://ws.pagseguro.uol.com.br"
   ps_url: "https://pagseguro.uol.com.br"
+  return_to: "http://www.sualoja.com.br/successo"
   email: matheustardivo@gmail.com
   token: "tokenGeradoPeloPagseguro"
 ```
 
-Para realizar os seus testes você pode usar um servidor de testes do Pagseguro que ainda está em fase de desenvolvimento, mas já pode ser acessado através do link: [Pagseguro Server](http://pss.tardivo.info)
+Para realizar os testes de integração da sua aplicação com o gateway, você pode usar um servidor de testes desenvolvido pelo próprio Pagseguro: [Pagseguro Server](https://github.com/carlosdelfino/PagSeguro-TestServer)
 
 ### Gerando a sua ordem de pagamento
 
@@ -60,7 +68,21 @@ Para realizar os seus testes você pode usar um servidor de testes do Pagseguro
 
 Agora basta usar a url retornada para enviar o usuário para efetuar o pagamento no site do Pagseguro.
 
+### Configurando opção para URL de retorno dinâmica
+
+Para configurar uma URL de retorno dinâmica a sua aplicação Rails, basta adicionar ao arquivo pagseguro.yml a opção return_to com o endereço para retorno que você configurou na sua aplicação:
+
+```yaml
+production:
+  ws_url: "https://ws.pagseguro.uol.com.br"
+  ps_url: "https://pagseguro.uol.com.br"
+  return_to: "http://www.sualoja.com.br/sucesso"
+  email: matheustardivo@gmail.com
+  token: "tokenGeradoPeloPagseguro"
+```
+
 ### Obtendo as notificações
+
 ```ruby
 # No seu controller
 def notificacao

data/lib/pagseguro_client/base.rb

@@ -23,6 +23,10 @@ module PagseguroClient
     @@config[Rails.env]
   end
 
+  def redirect?
+    config.has_key?("return_to")
+  end
+
   def ws_url
     config["ws_url"]
   end
@@ -39,6 +43,10 @@ module PagseguroClient
     config["email"]
   end
 
+  def redirect_url
+    config["return_to"]
+  end
+
   def checkout_url
     "#{ws_url}/v2/checkout"
   end

data/lib/pagseguro_client/generator.rb

@@ -0,0 +1,13 @@
+require "rails/generators/base"
+
+module PagseguroClient
+  class InstallGenerator < ::Rails::Generators::Base
+    namespace "pagseguro_client:install"
+
+    source_root File.dirname(__FILE__) + "/../../templates"
+
+    def copy_configuration_file
+      copy_file "config.yml", "config/pagseguro.yml"
+    end
+  end
+end

data/lib/pagseguro_client/order.rb

@@ -18,12 +18,9 @@ module PagseguroClient
     end
 
     def data
-      data = {
-        email: PagseguroClient.email,
-        token: PagseguroClient.token,
-        currency: "BRL",
-        reference: id
-      }
+      data = { email: PagseguroClient.email, token: PagseguroClient.token, currency: "BRL", reference: id }
+      data["redirectURL"] = PagseguroClient.redirect_url if PagseguroClient.redirect?
+
       products.each_with_index do |item, index|
         index += 1
         data["itemId#{index}"] = item[:id]

data/lib/pagseguro_client/railtie.rb

@@ -0,0 +1,7 @@
+module PagseguroClient
+  class Railtie < Rails::Railtie
+    generators do
+      require "pagseguro_client/generator"
+    end
+  end
+end

data/lib/pagseguro_client/version.rb

@@ -1,3 +1,3 @@
 module PagseguroClient
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/pagseguro_client.rb

@@ -4,4 +4,5 @@ require "rest-client"
 require "pagseguro_client/base"
 require "pagseguro_client/notification"
 require "pagseguro_client/order"
+require "pagseguro_client/railtie"
 require "pagseguro_client/version"

data/spec/pagseguro_client/base_spec.rb

@@ -1,11 +1,27 @@
 require "spec_helper"
 
 describe "Base" do
-  it "should return the payment url" do
-    PagseguroClient.payment_url("XPTO").should == "#{PagseguroClient.ws_url}/v2/checkout/payment.html?code=XPTO"
+  describe "checkout_url" do
+    it "should return the pagseguro checkout url" do
+      PagseguroClient.checkout_url.should == "#{PagseguroClient.ws_url}/v2/checkout"
+    end
   end
 
-  it "should return the notification url" do
-    PagseguroClient.notification_url("XPTO").should == "#{PagseguroClient.ws_url}/v2/transactions/notifications/XPTO"
+  describe "#payment_url" do
+    it "should return the pagseguro payment base url with the specified transaction code" do
+      PagseguroClient.payment_url("XPTO").should == "#{PagseguroClient.ws_url}/v2/checkout/payment.html?code=XPTO"
+    end
+  end
+
+  describe "#notification_url" do
+    it "should return the pagseguro ws_url base url with specified transaction code" do
+      PagseguroClient.notification_url("XPTO").should == "#{PagseguroClient.ws_url}/v2/transactions/notifications/XPTO"
+    end
+  end
+
+  describe "#redirect_url" do
+    it "should return the configured redirect_to URL" do
+      PagseguroClient.redirect_url.should == "#{PagseguroClient.redirect_url}"
+    end
   end
 end

data/spec/support/config/boot.rb

@@ -1,7 +1,9 @@
 ENV["BUNDLE_GEMFILE"] = File.dirname(__FILE__) + "/../../../Gemfile"
+
 require "bundler"
-Bundler.setup
 require "rails/all"
+
+Bundler.setup
 Bundler.require(:default)
 
 module PagSeguroClient

data/spec/support/config/pagseguro.yml

@@ -1,6 +1,7 @@
 development: &development
   ws_url: "http://localhost:4000"
   ps_url: "http://localhost:4000"
+  return_to: "http://localhost:4000/success"
   email: matheustardivo@gmail.com
   token: "a1951ac04115012fabb660334b97cc6e"
 

data/spec/support/log/test.log

@@ -0,0 +1,21 @@
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml
+Connecting to database specified by database.yml

data/template/config.yml

@@ -0,0 +1,12 @@
+development: &development
+  ws_url: "http://localhost:4000"
+  ps_url: "http://localhost:4000"
+  return_to: "http://localhost:4000/success"
+  email: your-email@pagseguro.com
+  token: "your-pagseguro-key-here"
+
+test:
+  <<: *development
+
+production:
+  <<: *development

data/templates/config.yml

@@ -0,0 +1,16 @@
+development: &development
+  ws_url: "http://localhost:4000"
+  ps_url: "http://localhost:4000"
+  return_to: "http://localhost:4000/successo"
+  email: matheustardivo@gmail.com
+  token: "tokenGeradoPeloPagseguro"
+
+test:
+  <<: *development
+
+production:
+  ws_url: "https://ws.pagseguro.uol.com.br"
+  ps_url: "https://pagseguro.uol.com.br"
+  return_to: "http://www.sualoja.com.br/successo"
+  email: matheustardivo@gmail.com
+  token: "tokenGeradoPeloPagseguro"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pagseguro_client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-06 00:00:00.000000000 Z
+date: 2012-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-rails
@@ -121,8 +121,10 @@ files:
 - Rakefile
 - lib/pagseguro_client.rb
 - lib/pagseguro_client/base.rb
+- lib/pagseguro_client/generator.rb
 - lib/pagseguro_client/notification.rb
 - lib/pagseguro_client/order.rb
+- lib/pagseguro_client/railtie.rb
 - lib/pagseguro_client/version.rb
 - pagseguro_client.gemspec
 - spec/pagseguro_client/base_spec.rb
@@ -137,6 +139,8 @@ files:
 - spec/support/log/.gitkeep
 - spec/support/log/test.log
 - spec/support/notification.xml
+- template/config.yml
+- templates/config.yml
 homepage: https://github.com/matheustardivo/pagseguro_client
 licenses: []
 post_install_message: