pagseguro 0.1.0

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation

data/Gemfile

@@ -0,0 +1,8 @@
+source :rubygems
+
+gem "rails", "3.0.0"
+gem "fakeweb"
+gem "rspec-rails", "2.0.0.beta.20"
+gem "faker"
+gem "ruby-debug19", :require => false
+gem "nokogiri"

data/Gemfile.lock

@@ -0,0 +1,104 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.0)
+      actionpack (= 3.0.0)
+      mail (~> 2.2.5)
+    actionpack (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    archive-tar-minitar (0.5.2)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    columnize (0.3.1)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    faker (0.3.1)
+    fakeweb (1.3.0)
+    i18n (0.4.1)
+    linecache19 (0.5.11)
+      ruby_core_source (>= 0.1.4)
+    mail (2.2.5)
+      activesupport (>= 2.3.6)
+      mime-types
+      treetop (>= 1.4.5)
+    mime-types (1.16)
+    nokogiri (1.4.3.1)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.4)
+      rack (>= 1.0)
+    rails (3.0.0)
+      actionmailer (= 3.0.0)
+      actionpack (= 3.0.0)
+      activerecord (= 3.0.0)
+      activeresource (= 3.0.0)
+      activesupport (= 3.0.0)
+      bundler (~> 1.0.0)
+      railties (= 3.0.0)
+    railties (3.0.0)
+      actionpack (= 3.0.0)
+      activesupport (= 3.0.0)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    rspec (2.0.0.beta.20)
+      rspec-core (= 2.0.0.beta.20)
+      rspec-expectations (= 2.0.0.beta.20)
+      rspec-mocks (= 2.0.0.beta.20)
+    rspec-core (2.0.0.beta.20)
+    rspec-expectations (2.0.0.beta.20)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.beta.20)
+    rspec-rails (2.0.0.beta.20)
+      rspec (= 2.0.0.beta.20)
+    ruby-debug-base19 (0.11.24)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby_core_source (>= 0.1.4)
+    ruby-debug19 (0.11.6)
+      columnize (>= 0.3.1)
+      linecache19 (>= 0.5.11)
+      ruby-debug-base19 (>= 0.11.19)
+    ruby_core_source (0.1.4)
+      archive-tar-minitar (>= 0.5.2)
+    thor (0.14.0)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faker
+  fakeweb
+  nokogiri
+  rails (= 3.0.0)
+  rspec-rails (= 2.0.0.beta.20)
+  ruby-debug19

data/README.markdown

@@ -0,0 +1,212 @@
+PAGSEGURO
+=========
+
+Este é um plugin do Ruby on Rails que permite utilizar o [PagSeguro](https://pagseguro.uol.com.br/?ind=689659), gateway de pagamentos do [UOL](http://uol.com.br).
+
+SOBRE O PAGSEGURO
+-----------------
+
+### Carrinho Próprio
+
+Trabalhando com carrinho próprio, sua loja mantém os dados do carrinho. O processo de inclusão de produtos no carrinho de compras acontece no próprio site da loja. Quando o comprador quiser finalizar sua compra, ele é enviado ao PagSeguro uma única vez com todos os dados de seu pedido. Aqui também, você tem duas opções. Pode enviar os dados do pedido e deixar o PagSeguro solicitar os dados do comprador, ou pode solicitar todos os dados necessários para a compra em sua loja e enviá-los ao PagSeguro.
+
+### Retorno Automático
+
+Após o processo de compra e pagamento, o usuário é enviado de volta a seu site. Para isso, você deve configurar uma [URL de retorno](https://pagseguro.uol.com.br/Security/ConfiguracoesWeb/RetornoAutomatico.aspx).
+
+Antes de enviar o usuário para essa URL, o robô do PagSeguro faz um POST para ela, em segundo plano, com os dados e status da transação. Lendo esse POST, você pode obter o status do pedido. Se o pagamento entrou em análise, ou se o usuário pagou usando boleto bancário, o status será "Aguardando Pagamento" ou "Em Análise". Nesses casos, quando a transação for confirmada (o que pode acontecer alguns dias depois) a loja receberá outro POST, informando o novo status. **Cada vez que a transação muda de status, um POST é enviado.**
+
+REQUISITOS
+----------
+
+A versão atual que está sendo mantida suporta Rails 3.0.0 ou superior.
+
+Se você quiser esta biblioteca em versão mais antigas do Rails (2.3, por exemplo) deverá usar o [branch legacy](http://github.com/fnando/pagseguro/tree/legacy). Note que esta versão não será mais atualizada com novas funcionalidades; apenas correções de bugs serão aplicadas.
+
+COMO USAR
+---------
+
+### Configuração
+
+O primeiro passo é instalar a biblioteca. Para isso, basta executar o comando
+
+	gem install pagseguro
+
+Se for utilizar o modo de desenvolvimento também precisará da gem Faker:
+
+	gem install faker
+
+Depois de instalar a biblioteca, você precisará executar gerar o arquivo de configuração, que deve residir em `config/pagseguro.yml`. Para gerar um arquivo de modelo execute
+
+	rails generate pagseguro:install
+
+O arquivo de configuração gerado será parecido com isto:
+
+	development: &development
+	  developer: true
+	  base: "http://localhost:3000"
+	  return_to: "/pedido/efetuado"
+	  email: user@example.com
+
+	test:
+	  <<: *development
+
+	production:
+	  authenticity_token: 9CA8D46AF0C6177CB4C23D76CAF5E4B0
+	  email: user@example.com
+	  return_to: "/pedido/efetuado"
+
+Este plugin possui um modo de desenvolvimento que permite simular a realização de pedidos e envio de notificações; basta utilizar a opção `developer`. Ela é ativada por padrão nos ambientes de desenvolvimento e teste. Você deve configurar as opções `base`, que deverá apontar para o seu servidor e a URL de retorno, que deverá ser configurada no próprio [PagSeguro](https://pagseguro.uol.com.br/?ind=689659), na página <https://pagseguro.uol.com.br/Security/ConfiguracoesWeb/RetornoAutomatico.aspx>.
+
+Para o ambiente de produção, que irá efetivamente enviar os dados para o [PagSeguro](https://pagseguro.uol.com.br/?ind=689659), você precisará adicionar o e-mail cadastrado como vendedor e o `authenticity_token`, que é o Token para Conferência de Segurança, que pode ser conseguido na página <https://pagseguro.uol.com.br/Security/ConfiguracoesWeb/RetornoAutomatico.aspx>.
+
+### Montando o formulário
+
+Para montar o seu formulário, você deverá utilizar a classe `PagSeguro::Order`. Esta classe deverá ser instanciada recebendo um identificador único do pedido. Este identificador permitirá identificar o pedido quando o [PagSeguro](https://pagseguro.uol.com.br/?ind=689659) notificar seu site sobre uma alteração no status do pedido.
+
+	class CartController < ApplicationController
+	  def checkout
+	    # Busca o pedido associado ao usuário; esta lógica deve
+	    # ser implementada por você, da maneira que achar melhor
+		@invoice = current_user.invoices.last
+
+		# Instanciando o objeto para geração do formulário
+	    @order = PagSeguro::Order.new(@invoice.id)
+
+	    # adicionando os produtos do pedido ao objeto do formulário
+	    @invoice.products.each do |product|
+	      # Estes são os atributos necessários. Por padrão, peso (:weight) é definido para 0,
+		  # quantidade é definido como 1 e frete (:shipping) é definido como 0.
+	      @order.add :id => product.id, :price => product.price, :description => product.title
+	    end
+	  end
+	end
+
+Se você precisar, pode definir o tipo de frete com o método `shipping_type`.
+
+	@order.shipping_type = "SD" # Sedex
+	@order.shipping_type = "EN" # PAC
+	@order.shipping_type = "FR" # Frete Próprio
+
+Depois que você definiu os produtos do pedido, você pode exibir o formulário.
+
+	<!-- app/views/cart/checkout.html.erb -->
+	<%= pagseguro_form @order, :submit => "Efetuar pagamento!" %>
+
+Por padrão, o formulário é enviado para o email no arquivo de configuração. Você pode mudar o email com a opção `:email`.
+
+	<%= pagseguro_form @order, :submit => "Efetuar pagamento!", :email => @account.email %>
+
+### Recebendo notificações
+
+Toda vez que o status de pagamento for alterado, o [PagSeguro](https://pagseguro.uol.com.br/?ind=689659) irá notificar sua URL de retorno com diversos dados. Você pode interceptar estas notificações com o método `pagseguro_notification`. O bloco receberá um objeto da classe `PagSeguro::Notification` e só será executado se for uma notificação verificada junto ao [PagSeguro](https://pagseguro.uol.com.br/?ind=689659).
+
+	class CartController < ApplicationController
+	  skip_before_filter :verify_authenticity_token
+
+	  def confirm
+	    return unless request.post?
+
+		pagseguro_notification do |notification|
+		  # Aqui você deve verificar se o pedido possui os mesmos produtos
+		  # que você cadastrou. O produto só deve ser liberado caso o status
+		  # do pedido seja "completed" ou "approved"
+		end
+
+		render :nothing => true
+	  end
+	end
+
+O método `pagseguro_notification` também pode receber como parâmetro o `authenticity_token` que será usado pra verificar a autenticação.
+
+	class CartController < ApplicationController
+	  skip_before_filter :verify_authenticity_token
+
+	  def confirm
+	    return unless request.post?
+		# Se você receber pagamentos de contas diferentes, pode passar o
+		# authenticity_token adequado como parâmetro para pagseguro_notification
+		account = Account.find(params[:seller_id])
+		pagseguro_notification(account.authenticity_token) do |notification|
+		end
+
+		render :nothing => true
+	  end
+	end
+
+O objeto `notification` possui os seguintes métodos:
+
+* `PagSeguro::Notification#products`: Lista de produtos enviados na notificação.
+* `PagSeguro::Notification#shipping`: Valor do frete
+* `PagSeguro::Notification#status`: Status do pedido
+* `PagSeguro::Notification#payment_method`: Tipo de pagamento
+* `PagSeguro::Notification#processed_at`: Data e hora da transação
+* `PagSeguro::Notification#buyer`: Dados do comprador
+* `PagSeguro::Notification#valid?(force=false)`: Verifica se a notificação é válido, confirmando-a junto ao PagSeguro. A resposta é jogada em cache e pode ser forçada com `PagSeguro::Notification#valid?(:force)`
+
+**ATENÇÃO:** Não se esqueça de adicionar `skip_before_filter :verify_authenticity_token` ao controller que receberá a notificação; caso contrário, uma exceção será lançada.
+
+### Utilizando modo de desenvolvimento
+
+Toda vez que você enviar o formulário no modo de desenvolvimento, um arquivo YAML será criado em `tmp/pagseguro-#{Rails.env}.yml`. Esse arquivo conterá todos os pedidos enviados.
+
+Depois, você será redirecionado para a URL de retorno que você configurou no arquivo `config/pagseguro.yml`. Para simular o envio de notificações, você deve utilizar a rake `pagseguro:notify`.
+
+	$ rake pagseguro:notify ID=<id do pedido>
+
+O ID do pedido deve ser o mesmo que foi informado quando você instanciou a class `PagSeguro::Order`. Por padrão, o status do pedido será `completed` e o tipo de pagamento `credit_card`. Você pode especificar esses parâmetros como o exemplo abaixo.
+
+	$ rake pagamento:notify ID=1 PAYMENT_METHOD=invoice STATUS=canceled NOTE="Enviar por motoboy" NAME="José da Silva" EMAIL="jose@dasilva.com"
+
+#### PAYMENT_METHOD
+
+* `credit_card`: Cartão de crédito
+* `invoice`: Boleto
+* `online_transfer`: Pagamento online
+* `pagseguro`: Transferência entre contas do PagSeguro
+
+#### STATUS
+
+* `completed`: Completo
+* `pending`: Aguardando pagamento
+* `approved`: Aprovado
+* `verifying`: Em análise
+* `canceled`: Cancelado
+* `refunded`: Devolvido
+
+AUTOR:
+------
+
+Nando Vieira (<http://simplesideias.com.br>)
+
+Recomendar no [Working With Rails](http://www.workingwithrails.com/person/7846-nando-vieira)
+
+COLABORADORES:
+--------------
+
+* Elomar (<http://github.com/elomar>)
+* Rafael (<http://github.com/rafaels>)
+
+LICENÇA:
+--------
+
+(The MIT License)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,25 @@
+require "rspec/core/rake_task"
+require File.dirname(__FILE__) + "/lib/pagseguro/version"
+
+RSpec::Core::RakeTask.new
+
+begin
+  require "jeweler"
+
+  JEWEL = Jeweler::Tasks.new do |gem|
+    gem.name = "pagseguro"
+    gem.version = PagSeguro::Version::STRING
+    gem.summary = "A wrapper for the PagSeguro payment gateway."
+    gem.description = ""
+    gem.authors = ["Nando Vieira"]
+    gem.email = "fnando.vieira@gmail.com"
+    gem.homepage = "http://github.com/fnando/pagseguro"
+    gem.has_rdoc = false
+    gem.files = FileList["{.rspec,Gemfile,Gemfile.lock,Rakefile,README.markdown,pagseguro.gemspec}", "{lib,spec,templates,test}/**/*"]
+    gem.add_development_dependency "rspec", ">= 2.0.0"
+  end
+
+  Jeweler::GemcutterTasks.new
+rescue LoadError => e
+  puts "You don't have Jeweler installed, so you won't be able to build gems."
+end

data/lib/pagseguro.rb

@@ -0,0 +1,66 @@
+require "net/https"
+require "uri"
+require "time"
+
+require "pagseguro/rake"
+require "pagseguro/railtie"
+require "pagseguro/notification"
+require "pagseguro/order"
+require "pagseguro/action_controller"
+require "pagseguro/helper"
+
+module PagSeguro
+  extend self
+
+  # PagSeguro receives all invoices in this URL. If developer mode is enabled,
+  # then the URL will be /pagseguro_developer/invoice
+  GATEWAY_URL = "https://pagseguro.uol.com.br/security/webpagamentos/webpagto.aspx"
+
+  # Hold the config/pagseguro.yml contents
+  @@config = nil
+
+  # The path to the configuration file
+  def config_file
+    Rails.root.join("config/pagseguro.yml")
+  end
+
+  # Check if configuration file exists.
+  def config?
+    File.exist?(config_file)
+  end
+
+  # Load configuration file.
+  def config
+    raise MissingConfigurationException, "file not found on #{config_file.inspect}" unless config?
+
+    # load file if is not loaded yet
+    @@config ||= YAML.load_file(config_file)
+
+    # raise an exception if the environment hasn't been set
+    # or if file is empty
+    if @@config == false || !@@config[Rails.env]
+      raise MissingEnvironmentException, ":#{Rails.env} environment not set on #{config_file.inspect}"
+    end
+
+    # retrieve the environment settings
+    @@config[Rails.env]
+  end
+
+  # The gateway URL will point to a local URL is
+  # app is running in developer mode
+  def gateway_url
+    if developer?
+      "/pagseguro_developer"
+    else
+      GATEWAY_URL
+    end
+  end
+
+  # Reader for the `developer` configuration
+  def developer?
+    config? && config["developer"] == true
+  end
+
+  class MissingEnvironmentException < StandardError; end
+  class MissingConfigurationException < StandardError; end
+end

data/lib/pagseguro/action_controller.rb

@@ -0,0 +1,11 @@
+module PagSeguro
+  module ActionController
+    private
+    def pagseguro_notification(token = nil, &block)
+      return unless request.post?
+
+      notification = PagSeguro::Notification.new(params, token)
+      yield notification if notification.valid?
+    end
+  end
+end

data/lib/pagseguro/developer_controller.rb

@@ -0,0 +1,26 @@
+module PagSeguro
+  class DeveloperController < ApplicationController
+    skip_before_filter :verify_authenticity_token
+    PAGSEGURO_ORDERS_FILE = File.join(Rails.root, "tmp", "pagseguro-#{Rails.env}.yml")
+
+    def create
+      # create the orders file if doesn't exist
+      FileUtils.touch(PAGSEGURO_ORDERS_FILE) unless File.exist?(PAGSEGURO_ORDERS_FILE)
+
+      # YAML caveat: if file is empty false is returned;
+      # we need to set default to an empty hash in this case
+      orders = YAML.load_file(PAGSEGURO_ORDERS_FILE) || {}
+
+      # add a new order, associating it with the order id
+      orders[params[:ref_transacao]] = params.except(:controller, :action, :only_path, :authenticity_token)
+
+      # save the file
+      File.open(PAGSEGURO_ORDERS_FILE, "w+") do |file|
+        file << orders.to_yaml
+      end
+
+      # redirect to the configuration url
+      redirect_to PagSeguro.config["return_to"]
+    end
+  end
+end