locaweb-gateway 0.1.6

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in locaweb-gateway.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (C) 2012 LOCAWEB SERVIÇOS DE INTERNET S.A.
+
+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/README.md

@@ -0,0 +1,49 @@
+# Locaweb Gateway
+
+## Install
+
+    gem install locaweb-gateway
+
+## Usage
+
+    Locaweb::Gateway.configure do |config|
+      config.token = '3a5bbed0-50d4-012f-8d73-0026bb5a6240'
+      config.environment = 'sandbox' # se não for passado irá utilizar production por default.
+    end
+
+    transaction = Locaweb::Gateway.criar(
+      :url_retorno => 'http://foo.com/url_retorno',
+      :capturar => true,
+      :pedido => {
+        :numero => "989012",
+        :total => "100.00",
+        :moeda => :real,
+        :descricao => "cylon toaster!"
+      },
+      :pagamento => {
+        :meio_pagamento => :cielo,
+        :bandeira => :visa,
+        :numero_cartao => "4012001037141112",
+        :cartao_codigo_verificacao => "973",
+        :parcelas => "1",
+        :tipo_operacao => "credito_a_vista",
+        :vencimento_cartao => "082015"
+      },
+      :comprador => {
+        :nome => "Bruna da Silva",
+        :documento => "12345678900",
+        :endereco => "Rua da Casa",
+        :numero => "23",
+        :cep => "09710240",
+        :bairro => "Centro",
+        :cidade => "São Paulo",
+        :estado => "SP"
+      }
+    )
+    Locaweb::Gateway.consultar(transaction.id)
+    Locaweb::Gateway.cancelar(transaction.id)
+    Locaweb::Gateway.capturar(transaction.id)
+
+## Docs
+
+[Documentação do Gateway de Pagamentos Locaweb](http://docs.gatewaylocaweb.com.br)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/locaweb-gateway.rb

@@ -0,0 +1,19 @@
+require 'rest-client'
+require 'active_support/core_ext/class'
+require 'active_support/core_ext/object'
+require 'ostruct'
+require 'locaweb-gateway/actions'
+require 'locaweb-gateway/config'
+require 'locaweb-gateway/transaction'
+require 'locaweb-gateway/request'
+require 'locaweb-gateway/response'
+
+module Locaweb
+  module Gateway
+    extend Locaweb::Gateway::Actions
+
+    def self.configure(&block)
+      Locaweb::Gateway::Config.configure(&block)
+    end
+  end
+end

data/lib/locaweb-gateway/actions.rb

@@ -0,0 +1,34 @@
+module Locaweb
+  module Gateway
+    module Actions
+      def create(params)
+        request  = ::Locaweb::Gateway::Request.new(:action => "/")
+        Response.new(request.post(gateway_params(params))).parse
+      end
+      alias :criar :create
+
+      def cancel(id)
+        request  = ::Locaweb::Gateway::Request.new(:action => "/#{id}/estornar")
+        Response.new(request.post(gateway_params)).parse
+      end
+      alias :cancelar :cancel
+
+      def capture(id)
+        request  = ::Locaweb::Gateway::Request.new(:action => "/#{id}/capturar")
+        Response.new(request.post(gateway_params)).parse
+      end
+      alias :capturar :capture
+
+      def show(id)
+        request  = ::Locaweb::Gateway::Request.new(:action => "/#{id}")
+        Response.new(request.get(gateway_params)).parse
+      end
+      alias :consultar :show
+
+      def gateway_params(params={})
+        attributes = params.empty? ? {} :  { :transacao => params }
+        attributes.merge(:token => Locaweb::Gateway::Config.token)
+      end
+    end
+  end
+end

data/lib/locaweb-gateway/config.rb

@@ -0,0 +1,36 @@
+module Locaweb
+  module Gateway
+    class Config
+      # The class variable that represents the user token.
+      #
+      cattr_accessor :token
+      self.token = ''
+
+      # The class variable that represents the environment that the transaction will be processed
+      # <b>OBS.:</b>: Defaults to production
+      #
+      cattr_accessor :environment
+      self.environment = :production
+
+      # TODO: put ssl and the request object should read from this.
+      #
+      # cattr_accessor :ssl, :ssl_client_cert, :ssl_client_key, :ssl_ca_file
+      # self.ssl = false
+      #
+
+      # Returns the base endpoint for the Locaweb Payment Gateway.
+      #
+      def self.base_uri
+        if environment.equal?(:production)
+          'https://api.gatewaylocaweb.com.br/v1/transacao'
+        else
+          'https://api-sandbox.gatewaylocaweb.com.br/v1/transacao'
+        end
+      end
+
+      def self.configure(&block)
+        block.call(self)
+      end
+    end
+  end
+end

data/lib/locaweb-gateway/request.rb

@@ -0,0 +1,35 @@
+module Locaweb
+  module Gateway
+    class Request
+      attr_reader :engine, :action
+      delegate :base_uri, :to => Locaweb::Gateway::Config
+
+      def initialize(options={})
+        @action = options[:action]
+        @engine = RestClient
+      end
+
+      def request_uri
+        "#{base_uri}#{action}"
+      end
+
+      def post(params)
+        http_request(:method => :post, :params => params.to_json)
+      end
+
+      def get(params)
+        http_request(:method => :get, :params => { :params => params })
+      end
+
+      private
+
+      def http_request(options={})
+        response = begin
+          engine.send(options[:method], request_uri, options[:params])
+        rescue RestClient::Exception => bad_request
+          OpenStruct.new(:body => bad_request.http_body, :to_i => bad_request.http_code)
+        end
+      end
+    end
+  end
+end

data/lib/locaweb-gateway/response.rb

@@ -0,0 +1,32 @@
+module Locaweb
+  module Gateway
+    class Response
+      attr_reader :raw_response, :body, :http_status
+
+      def initialize(raw_response)
+        @raw_response = raw_response
+        @body = JSON.parse(raw_response.body.to_s)
+        @http_status = raw_response.to_i
+      end
+
+      def parse
+        transaction = Locaweb::Gateway::Transaction.new
+        transaction.response = self
+        transaction_node = @body['transacao'] || {}
+        error_node = transaction_node['erro'] || {}
+
+        transaction.id             = transaction_node['id']
+        transaction.status         = transaction_node['status']
+        transaction.url_acesso     = transaction_node['url_acesso']
+        transaction.meio_pagamento = transaction_node['meio_pagamento']
+        transaction.numero_pedido  = transaction_node['numero_pedido']
+        transaction.detalhes       = transaction_node['detalhes']
+        transaction.erro           = error_node.symbolize_keys
+        transaction.erro_codigo    = error_node['codigo']
+        transaction.erro_mensagem  = error_node['mensagem']
+
+        transaction
+      end
+    end
+  end
+end

data/lib/locaweb-gateway/transaction.rb

@@ -0,0 +1,16 @@
+require 'locaweb-gateway/actions'
+
+module Locaweb
+  module Gateway
+    class Transaction
+      extend ::Locaweb::Gateway::Actions
+
+      attr_accessor :response, :id, :status, :url_acesso, :meio_pagamento, :numero_pedido, :detalhes
+      attr_accessor :erro, :erro_codigo, :erro_mensagem
+
+      def initialize
+        @detalhes = {}
+      end
+    end
+  end
+end

data/lib/locaweb-gateway/version.rb

@@ -0,0 +1,5 @@
+module Locaweb
+  module Gateway
+    VERSION = "0.1.6"
+  end
+end

data/lib/locaweb_gateway.rb

@@ -0,0 +1 @@
+require 'locaweb-gateway'

data/locaweb-gateway.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "locaweb-gateway/version"
+
+Gem::Specification.new do |s|
+  s.name        = "locaweb-gateway"
+  s.version     = Locaweb::Gateway::VERSION
+  s.authors     = ["Locaweb - Saas"]
+  s.email       = ["atendimento@locaweb.com.br"]
+  s.homepage    = "http://github.com/locaweb/locaweb-gateway-ruby"
+  s.summary     = %q{Locaweb Payment Gateway Gem}
+  s.description = %q{This gem was designed to help you to access the locaweb payment gateway.}
+
+  s.rubyforge_project = "locaweb-gateway"
+
+  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_dependency 'rest-client'
+  s.add_dependency 'activesupport'
+  s.add_dependency 'json'
+
+  s.add_development_dependency 'rspec'
+end

data/spec/locaweb-gateway/config_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+module Locaweb
+  module Gateway
+    describe Config do
+      describe ".token" do
+        it "should return an empty string if dont pass a token" do
+          Config.token.should == ''
+        end
+      end
+
+      describe ".environment" do
+        it "should have production as default" do
+          Config.environment.should be :production
+        end
+      end
+
+      describe ".base_uri" do
+        it "should return the production base uri" do
+          Config.stub(:environment).and_return(:production)
+          Config.base_uri.should == 'https://api.gatewaylocaweb.com.br/v1/transacao'
+        end
+
+        it "should return the sandbox base uri" do
+          Config.stub(:environment).and_return(:sandbox)
+          Config.base_uri.should == 'https://api-sandbox.gatewaylocaweb.com.br/v1/transacao'
+        end
+      end
+    end
+  end
+end

data/spec/locaweb-gateway/request_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+module Locaweb
+  module Gateway
+    describe Request do
+      subject { Request.new(:action => '/') }
+
+      describe "#action" do
+        it "should read the action instance variable" do
+          subject.action.should == '/'
+        end
+      end
+
+      describe "#request_uri" do
+        subject { Request.new(:action => '/foo') }
+
+        it "should join the base endpoint with the requested action" do
+          subject.stub(:base_uri).and_return('https://api.gatewaylocaweb.com.br/v1/transacao')
+          subject.request_uri.should == 'https://api.gatewaylocaweb.com.br/v1/transacao/foo'
+        end
+      end
+
+      describe "#engine" do
+        it "should have RestClient as default" do
+          subject.engine.should be RestClient
+        end
+      end
+
+      describe "#post" do
+        it "should pass post to the base endpoint and return the response" do
+          subject.engine.should_receive(:post).with(subject.request_uri, "{\"foo\":\"bar\"}").and_return(invalid_credentials)
+          subject.post(:foo => :bar)
+        end
+
+        it "should not raise an exception when rest raise exception" do
+          subject.engine.should_receive(:post).and_raise(RestClient::ResourceNotFound)
+          expect { subject.post(:foo => :bar) }.to_not raise_error
+        end
+      end
+
+      describe "#get" do
+        it "should pass the get to the engine and return an response" do
+          subject.engine.should_receive(:get).with(subject.request_uri, { :params => { :foo => :bar }}).and_return(invalid_credentials)
+          subject.get(:foo => :bar)
+        end
+
+        it "should not raise an exception when the engine raise exception" do
+          subject.engine.should_receive(:get).and_raise(RestClient::ResourceNotFound)
+          expect { subject.get(:foo => :bar) }.to_not raise_error
+        end
+      end
+    end
+  end
+end

data/spec/locaweb-gateway/response_spec.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+require 'spec_helper'
+
+module Locaweb
+  module Gateway
+    describe Response do
+      describe "#parse" do
+        context 'on invalid credentital' do
+          subject { Response.new(ResponseFixture.new(:body => invalid_credentials, :status => 403)) }
+
+          it "should parse the transaction in error node with code and message" do
+            transaction = subject.parse
+            transaction.erro.should == { :codigo => '001', :mensagem => 'Credenciais inválidas' }
+            transaction.erro_codigo.should == '001'
+            transaction.erro_mensagem.should == 'Credenciais inválidas'
+          end
+        end
+
+        context 'on transaction not found' do
+          subject { Response.new(ResponseFixture.new(:body => transaction_not_found, :status => 404))}
+
+          it "should parse the transaction in error node with code and message" do
+            transaction = subject.parse
+            transaction.erro.should == { :codigo => '006', :mensagem => 'Recurso não encontrado' }
+            transaction.erro_codigo.should == '006'
+            transaction.erro_mensagem.should == 'Recurso não encontrado'
+          end
+        end
+
+        context 'on cielo success response' do
+          subject { Response.new(ResponseFixture.new(:body => cielo_success_response, :status => 201))}
+
+          it "should parse the transaction and return the id, status, url_acesso and meio_pagamento" do
+            transaction = subject.parse
+            transaction.id.should == '152'
+            transaction.status.should == 'pago'
+            transaction.url_acesso.should == 'http://api.gatewaylocaweb.com.br/v1/transacao/foobar'
+            transaction.meio_pagamento.should == 'cielo'
+            transaction.numero_pedido.should == '876'
+            transaction.detalhes.should == { "tid" => "10017", "nsu" => "998877", "pan" => "887766", "arp" => "776655", "lr"  => nil }
+          end
+        end
+
+        context 'on itau shopline success response' do
+          subject { Response.new(ResponseFixture.new(:body => itau_shopline_success_response, :status => 201))}
+
+          it "should parse the transaction and return the id, status, meio_pagamento, url_acesso and detalhes" do
+            transaction = subject.parse
+            transaction.id.should == '159'
+            transaction.status.should == 'aguardando pagamento'
+            transaction.url_acesso.should == 'https://api-gateway.devintegration.locaweb.com.br/v1/itau_shopline/fd350d45-0b26-4dcf-8455-3f755bd71826'
+            transaction.numero_pedido.should == '654'
+            transaction.detalhes.should == { "nsu" => nil, "tipo_pagamento" => nil, "data_pagamento" => nil, "numero_autorizacao" => nil, "tipo_cartao" => nil }
+          end
+        end
+      end
+    end
+  end
+end

data/spec/locaweb-gateway_spec.rb

@@ -0,0 +1,6 @@
+require 'spec_helper'
+
+module Locaweb
+  describe Gateway do
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require "locaweb-gateway"
+
+Dir['spec/support/*.rb'].each { |file| require File.expand_path(file) }
+
+RSpec.configure do |config|
+  config.include GatewayJSONResponse
+end

data/spec/support/gateway_json_response.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+module GatewayJSONResponse
+  def invalid_credentials
+    "{\"transacao\":{\"erro\":{\"codigo\":\"001\",\"mensagem\":\"Credenciais inválidas\"}}}"
+  end
+
+  def transaction_not_found
+    "{\"transacao\":{\"erro\":{\"codigo\":\"006\",\"mensagem\":\"Recurso não encontrado\"}}}"
+  end
+
+  def payment_way_not_valid
+     "{\"transacao\":{\"erro\":{\"codigo\":\"004\",\"mensagem\":\"Meio de pagamento não é válido\"}}}"
+  end
+
+  def cielo_success_response
+    {
+      "transacao" => {
+        "id" => "152",
+        "status" => "pago",
+        "url_acesso" => "http://api.gatewaylocaweb.com.br/v1/transacao/foobar",
+        "meio_pagamento" => "cielo",
+        "numero_pedido" => "876",
+        "erro" => nil,
+        "detalhes" => {
+          "tid" => "10017",
+          "nsu" => "998877",
+          "pan" => "887766",
+          "arp" => "776655",
+          "lr"  => nil
+        }
+      }
+    }.to_json
+  end
+
+  def itau_shopline_success_response
+    {
+      "transacao" => {
+        "id" => "159",
+        "status" => "aguardando pagamento",
+        "meio_pagamento" => "itau_shopline",
+        "numero_pedido" => "654",
+        "url_acesso" => "https://api-gateway.devintegration.locaweb.com.br/v1/itau_shopline/fd350d45-0b26-4dcf-8455-3f755bd71826",
+        "erro" => nil,
+        "detalhes" => {
+          "nsu" => nil,
+          "tipo_pagamento" => nil,
+          "data_pagamento" => nil,
+          "numero_autorizacao" => nil,
+          "tipo_cartao" => nil
+        }
+      }
+    }.to_json
+  end
+end

data/spec/support/response_fixture.rb

@@ -0,0 +1,9 @@
+class ResponseFixture
+  attr_reader :body, :to_i, :headers
+
+  def initialize(options={})
+    @body    = options[:body]
+    @to_i    = options[:status] # RestClient Response Status code is #to_i :S
+    @headers = []
+  end
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: locaweb-gateway
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+  prerelease: 
+platform: ruby
+authors:
+- Locaweb - Saas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem was designed to help you to access the locaweb payment gateway.
+email:
+- atendimento@locaweb.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- builds/locaweb-gateway-0.1.0.gem
+- builds/locaweb-gateway-0.1.1.gem
+- builds/locaweb-gateway-0.1.4.gem
+- lib/locaweb-gateway.rb
+- lib/locaweb-gateway/actions.rb
+- lib/locaweb-gateway/config.rb
+- lib/locaweb-gateway/request.rb
+- lib/locaweb-gateway/response.rb
+- lib/locaweb-gateway/transaction.rb
+- lib/locaweb-gateway/version.rb
+- lib/locaweb_gateway.rb
+- locaweb-gateway.gemspec
+- spec/locaweb-gateway/config_spec.rb
+- spec/locaweb-gateway/request_spec.rb
+- spec/locaweb-gateway/response_spec.rb
+- spec/locaweb-gateway_spec.rb
+- spec/spec_helper.rb
+- spec/support/gateway_json_response.rb
+- spec/support/response_fixture.rb
+homepage: http://github.com/locaweb/locaweb-gateway-ruby
+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: locaweb-gateway
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Locaweb Payment Gateway Gem
+test_files: []