pagseguro_client 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rbenv-gemsets

@@ -0,0 +1 @@
+pagseguro_client

data/.rspec

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

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/README.markdown

@@ -0,0 +1,123 @@
+# PAGSEGURO Client
+
+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
+* 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)
+
+## Como usar
+
+### Instalação
+
+Adicione a biblioteca ao arquivo Gemfile: 
+
+```ruby
+gem 'pagseguro_client', git: "git://github.com/matheustardivo/pagseguro_client.git"
+```
+
+E crie o arquivo de configuração em `config/pagseguro.yml`: 
+
+```yaml
+development: &development
+  base_url: "http://localhost:4000"
+  email: matheustardivo@gmail.com
+  token: "a1951ac04115012fabb660334b97cc6e"
+
+test:
+  <<: *development
+
+production:
+  base_url: "https://ws.pagseguro.uol.com.br"
+  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)
+
+### Gerando a sua ordem de pagamento
+
+```ruby
+@order = PagseguroClient::Order.new(id) # Seu identificador da ordem de pagamento
+@order.add(
+  id: "1", # Seu identificador do produto
+  description: produto.descricao, 
+  amount: produto.preco)
+@response = order.send_request
+```
+
+### Exemplo de resposta da ordem de pagamento
+
+```ruby
+# Hash
+{
+  code: "8CF4BE7DCECEF0F004A6DFA0A8243412",
+  url: "https://ws.pagseguro.uol.com.br/v2/checkout/payment.html?code=8CF4BE7DCECEF0F004A6DFA0A8243412"
+}
+```
+
+Agora basta usar a url retornada para enviar o usuário para efetuar o pagamento no site do Pagseguro.
+
+### Obtendo as notificações
+```ruby
+# No seu controller
+def notificacao
+  return unless request.post?
+  
+  @notification = PagseguroClient::Notification.retrieve(params[:notificationCode])
+  # Seu código para utilizar a notificação
+  
+  render nothing: true
+end
+```
+
+O objeto `notification` possui os seguintes métodos:
+
+* `PagseguroClient::Notification#code`: Código da notificação
+* `PagseguroClient::Notification#order_id`: Código da sua ordem de pagamento
+* `PagseguroClient::Notification#order_code`: Código do Pagseguro para sua ordem de pagamento
+* `PagseguroClient::Notification#status`: Status da ordem de pagamento atual
+* `PagseguroClient::Notification#payment_method`: Método utilizado para o pagamento
+
+#### Métodos de pagamento
+
+* `credit_card`: Cartão de crédito
+* `invoice`: Boleto
+* `online_transfer`: Pagamento online
+* `pagseguro`: Transferência entre contas do PagSeguro
+* `oi_paggo`: Oi Paggo :)
+
+#### Status
+
+* `pending`: Aguardando pagamento
+* `verifying`: Em análise
+* `approved`: Aprovado
+* `available`: Disponível
+* `refunded`: Devolvido
+* `canceled`: Cancelado
+
+## Autor
+Matheus Tardivo (<http://matheustardivo.com>)
+
+## 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,5 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new

data/lib/pagseguro_client/base.rb

@@ -0,0 +1,40 @@
+module PagseguroClient
+  extend self
+
+  @@config = nil
+
+  def config_file
+    Rails.root.join("config/pagseguro.yml")
+  end
+
+  def config?
+    File.exist?(config_file)
+  end
+
+  def config
+    raise MissingConfigurationError, "file not found on #{config_file.inspect}" unless config?
+
+    @@config ||= YAML.load_file(config_file)
+
+    if @@config == false || !@@config[Rails.env]
+      raise MissingEnvironmentError, ":#{Rails.env} environment not set on #{config_file.inspect}"
+    end
+
+    @@config[Rails.env]
+  end
+  
+  def base_url
+    config["base_url"]
+  end
+  
+  def token
+    config["token"]
+  end
+  
+  def email
+    config["email"]
+  end
+
+  class MissingEnvironmentError < StandardError; end
+  class MissingConfigurationError < StandardError; end
+end

data/lib/pagseguro_client/notification.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+module PagseguroClient
+  class Notification
+    PAYMENT_METHOD = {
+      1 => :credit_card,
+      2 => :invoice,
+      3 => :online_transfer,
+      4 => :pagseguro,
+      5 => :oi_paggo
+    }
+    
+    STATUS = {
+      1 => :pending,
+      2 => :verifying,
+      3 => :approved,
+      4 => :available,
+      6 => :refunded,
+      7 => :canceled
+    }
+    
+    attr_accessor :code, :order_id, :order_code, :status, :payment_method
+    
+    def initialize(attributes = {})
+      attributes.each do |name, value|
+        send("#{name}=", value)
+      end
+    end
+    
+    def self.retrieve(code)
+      response = RestClient.get("#{PagseguroClient.base_url}/v2/transactions/notifications/#{code}",
+        {
+          params: {
+            email: PagseguroClient.email, 
+            token: PagseguroClient.token
+          }
+        }
+      )
+
+      doc = Nokogiri::XML(response.body)
+      order_id = doc.xpath("//reference").text
+      order_code = doc.xpath("//code").text
+      status = doc.xpath("//status").text.to_i
+      payment_method = doc.xpath("//paymentMethod/type").text.to_i
+      
+      Notification.new(
+        code: code, 
+        order_id: order_id, 
+        order_code: order_code, 
+        status: STATUS[status], 
+        payment_method: PAYMENT_METHOD[payment_method]
+      )
+    end
+  end
+end

data/lib/pagseguro_client/order.rb

@@ -0,0 +1,52 @@
+module PagseguroClient
+  class Order
+    
+    attr_accessor :id, :products
+    
+    def initialize(order_id)
+      self.id = order_id
+      self.products = []
+    end
+    
+    # The allowed values are:
+    # - id (Required. Should match the product in your database)
+    # - description (Required. Identifies the product)
+    # - amount (Required. If float, will be multiplied by 100 cents)
+    # - quantity (Optional. If not supplied, use 1)
+    def add(options)
+      products.push(options)
+    end
+    
+    def data
+      data = {
+        email: PagseguroClient.email,
+        token: PagseguroClient.token,
+        currency: "BRL",
+        reference: id
+      }
+      products.each_with_index do |item, index|
+        index += 1
+        data["itemId#{index}"] = item[:id]
+        data["itemDescription#{index}"] = item[:description]
+        data["itemAmount#{index}"] = item[:amount]
+        data["itemQuantity#{index}"] = item[:quantity] || 1
+      end
+      
+      data
+    end
+    
+    # Send a new payment request to Pagseguro
+    # Returns the URL to redirect your user to complete the payment in Pagseguro
+    def send_request
+      response = RestClient.post("#{PagseguroClient.base_url}/v2/checkout", data)
+
+      doc = Nokogiri::XML(response.body)
+      code = doc.xpath("//code").text
+
+      {
+        code: code,
+        url: "#{PagseguroClient.base_url}/v2/checkout/payment.html?code=#{code}"
+      }
+    end
+  end
+end

data/lib/pagseguro_client/version.rb

@@ -0,0 +1,3 @@
+module PagseguroClient
+  VERSION = "0.0.1"
+end

data/lib/pagseguro_client.rb

@@ -0,0 +1,7 @@
+require "nokogiri"
+require "rest-client"
+
+require "pagseguro_client/base"
+require "pagseguro_client/notification"
+require "pagseguro_client/order"
+require "pagseguro_client/version"

data/pagseguro_client.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "pagseguro_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "pagseguro_client"
+  s.version     = PagseguroClient::VERSION
+  s.authors     = ["Matheus Tardivo"]
+  s.email       = ["matheustardivo@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{The library to access the new services from Pagseguro (v2)}
+  s.description = s.summary
+
+  s.rubyforge_project = "pagseguro_client"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency  "rspec-rails"  , "~> 2.7"
+  s.add_development_dependency  "rails"        , "~> 3.2"
+  s.add_development_dependency  "rake"         , "~> 0.9"
+  s.add_development_dependency  "sqlite3"      , "~> 1.3"
+  s.add_runtime_dependency      "nokogiri"     , "~> 1.5"
+  s.add_runtime_dependency      "rest-client"  , "~> 1.6"
+end

data/spec/pagseguro_client/notification_spec.rb

@@ -0,0 +1,5 @@
+require "spec_helper"
+
+describe PagseguroClient::Notification do
+  
+end

data/spec/pagseguro_client/order_spec.rb

@@ -0,0 +1,34 @@
+require "spec_helper"
+
+describe PagseguroClient::Order do
+  
+  it "should set order id when instantiating object" do
+    order = PagseguroClient::Order.new("ABCDEF")
+    order.id.should == "ABCDEF"
+  end
+  
+  it "should add product" do
+    order = PagseguroClient::Order.new("John Doe")
+    order.add(id: "1", description: "Description", amount: 199)
+    order.products.should_not be_empty
+    order.products.size.should == 1
+    order.products.first[:id].should == "1"
+  end
+  
+  it "should set order product data" do
+    order = PagseguroClient::Order.new("John Doe")
+    order.add(id: "1", description: "Description", amount: 199)
+    order.add(id: "2", description: "Description", amount: 199)
+    order.add(id: "3", description: "Description", amount: 199)
+    
+    data = order.data
+    data.keys.include?("itemId1").should be_true
+    data.keys.include?("itemId2").should be_true
+    data.keys.include?("itemId3").should be_true
+    
+    data["itemId1"].should == "1"
+    data["itemId2"].should == "2"
+    data["itemId3"].should == "3"
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+ENV["RAILS_ENV"] = "test"
+
+require "rails"
+require "pagseguro_client"
+require "support/config/boot"
+require "rspec/rails"

data/spec/support/app/controllers/application_controller.rb

@@ -0,0 +1,2 @@
+class ApplicationController < ActionController::Base
+end

data/spec/support/app/models/account.rb

@@ -0,0 +1,2 @@
+class Account < ActiveRecord::Base
+end

data/spec/support/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  authentication
+end

data/spec/support/config/boot.rb

@@ -0,0 +1,14 @@
+ENV["BUNDLE_GEMFILE"] = File.dirname(__FILE__) + "/../../../Gemfile"
+require "bundler"
+Bundler.setup
+require "rails/all"
+Bundler.require(:default)
+
+module PagSeguroClient
+  class Application < Rails::Application
+    config.root = File.dirname(__FILE__) + "/.."
+    config.active_support.deprecation = :log
+  end
+end
+
+PagSeguroClient::Application.initialize!

data/spec/support/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: ":memory:"

data/spec/support/config/pagseguro.yml

@@ -0,0 +1,10 @@
+development: &development
+  base_url: "http://localhost:4000"
+  email: matheustardivo@gmail.com
+  token: "a1951ac04115012fabb660334b97cc6e"
+
+test:
+  <<: *development
+
+production:
+  <<: *development

data/spec/support/config/routes.rb

@@ -0,0 +1,4 @@
+PagSeguroClient::Application.routes.draw do
+  get "dashboard", :to => "dashboard#index"
+  get "login", :to => "session#new"
+end

data/spec/support/notification.xml

@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="ISO-8859-1" standalone="yes"?>
+<transaction>
+	<date>2011-02-10T16:13:41.000-03:00</date>
+	<code>9E884542-81B3-4419-9A75-BCC6FB495EF1</code>
+	<reference>REF1234</reference>
+	<type>1</type>
+	<status>3</status>
+	<paymentMethod>
+		<type>1</type>
+		<code>101</code>
+	</paymentMethod>
+	<grossAmount>49900.00</grossAmount>
+	<discountAmount>0.00</discountAmount>
+	<feeAmount>0.00</feeAmount>
+	<netAmount>49900.00</netAmount>
+	<extraAmount>0.00</extraAmount>
+	<installmentCount>1</installmentCount>
+	<itemCount>2</itemCount>
+	<items>
+		<item>
+			<id>0001</id>
+			<description>Notebook Prata</description>
+			<quantity>1</quantity>
+			<amount>24300.00</amount>
+		</item>
+		<item>
+			<id>0002</id>
+			<description>Notebook Rosa</description>
+			<quantity>1</quantity>
+			<amount>25600.00</amount>
+		</item>
+	</items>
+	<sender>
+		<name>José Comprador</name>
+		<email>comprador@uol.com.br</email>
+		<phone>
+			<areaCode>11</areaCode>
+			<number>56273440</number>
+		</phone>
+	</sender>
+	<shipping>
+		<address>
+			<street>Av. Brig. Faria Lima</street>
+			<number>1384</number>
+			<complement>5o andar</complement>
+			<district>Jardim Paulistano</district>
+			<postalCode>01452002</postalCode>
+			<city>Sao Paulo</city>
+			<state>SP</state>
+			<country>BRA</country>
+		</address>
+		<type>1</type>
+		<cost>21.50</cost>
+	</shipping>
+</transaction>

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: pagseguro_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Matheus Tardivo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: &70144902931820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: *70144902931820
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &70144902931020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: *70144902931020
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70144902930560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: *70144902930560
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70144902930100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: *70144902930100
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70144902945860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70144902945860
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &70144902945020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70144902945020
+description: The library to access the new services from Pagseguro (v2)
+email:
+- matheustardivo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-gemsets
+- .rspec
+- Gemfile
+- README.markdown
+- Rakefile
+- lib/pagseguro_client.rb
+- lib/pagseguro_client/base.rb
+- lib/pagseguro_client/notification.rb
+- lib/pagseguro_client/order.rb
+- lib/pagseguro_client/version.rb
+- pagseguro_client.gemspec
+- spec/pagseguro_client/notification_spec.rb
+- spec/pagseguro_client/order_spec.rb
+- spec/spec_helper.rb
+- spec/support/app/controllers/application_controller.rb
+- spec/support/app/models/account.rb
+- spec/support/app/models/user.rb
+- spec/support/app/views/dashboard/index.erb
+- spec/support/app/views/session/new.erb
+- spec/support/config/boot.rb
+- spec/support/config/database.yml
+- spec/support/config/pagseguro.yml
+- spec/support/config/routes.rb
+- spec/support/log/.gitkeep
+- spec/support/log/test.log
+- spec/support/notification.xml
+homepage: ''
+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: pagseguro_client
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: The library to access the new services from Pagseguro (v2)
+test_files:
+- spec/pagseguro_client/notification_spec.rb
+- spec/pagseguro_client/order_spec.rb
+- spec/spec_helper.rb
+- spec/support/app/controllers/application_controller.rb
+- spec/support/app/models/account.rb
+- spec/support/app/models/user.rb
+- spec/support/app/views/dashboard/index.erb
+- spec/support/app/views/session/new.erb
+- spec/support/config/boot.rb
+- spec/support/config/database.yml
+- spec/support/config/pagseguro.yml
+- spec/support/config/routes.rb
+- spec/support/log/.gitkeep
+- spec/support/log/test.log
+- spec/support/notification.xml