mercadopago 0.0.1

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags

data/Gemfile

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

data/README.md

@@ -0,0 +1,196 @@
+MercadoPago
+===========
+
+Esta gem para Ruby é um cliente que permite que desenvolvedores acessem os serviços do http://www.mercadopago.com (MercadoPago).
+
+Antes de começar a usá-la, é recomendável conhecer mais sobre as APIs do MercadoPago e ler as suas documentações. Como esta gem utiliza hashes para representar requests e responses, é necessário conhecer os parâmetros das APIs do MercadoPago para fazer as chamadas corretas e processar as respostas corretamente.
+
+Para conhecer a documentação das APIs do MercadoPago, veja este link: https://developers.mercadopago.com/integracao-checkout
+
+Instalação
+----------
+
+Você pode instalar a última versão da gem MercadoPago com o seguinte comando:
+
+	gem install mercadopago
+	
+Você pode também adicionar a gem ao Gemfile do seu projeto:
+
+	gem 'mercadopago'
+
+Credenciais de acesso
+---------------------
+
+Para usar esta gem, é necessário fornecer o client_id e um client_secret da sua conta do MercaodPago. Esta gem não armazena este dados sob nenhuma hipótese. Para consultar as suas credenciais no MercadoPago, acesse o link a seguir: https://www.mercadopago.com/mlb/ferramentas/aplicacoes
+
+Exemplos
+--------
+
+### Autenticação
+	
+	# Use as suas credenciais.
+	client_id = '1234'
+	client_secret = 'abcdefghijklmnopqrstuvwxyz'
+	
+	access = Mercadopago::Authentication.access_token(client_id, client_secret)
+	
+A resposta desta requisição será um hash como o que segue:
+
+	{
+		"access_token" => "APP_USR-1234-999999-abcdefghijklmnopqrstuvwxyz-999999999",
+		"token_type" => "bearer",
+		"expires_in" => 10800,
+		"scope" => "mclics_advertising offline_access read write",
+		"refresh_token" => "TG-abcdefghijklmnopqrstuvwxyz"
+	}
+	
+Você deverá usar o "access_token" nas demais requisições para outros webservices.
+
+### Criação de pagamento
+
+	data = {
+	  "external_reference" => "OPERATION-ID-1234",
+	  "items" => [
+	    {
+	      "id" => "Código 123",
+	      "title" => "Nome produto",
+	      "description" => "Descrição produto",
+	      "quantity" => 1,
+	      "unit_price" => 10.50,
+	      "currency_id" => "BRL",
+	      "picture_url" => "http://www.site.com.br/image/123.png"
+	    }
+		],
+		"payer" => {
+		  "name"=> "João",
+		  "surname"=> "Silva",
+	    "email"=> "comprador@email.com.br"
+	  },
+	  "back_urls"=> {
+	    "pending"=> "https://www.site.com.br/pending",
+	    "success"=> "http://www.site.com.br/success",
+			"failure"=> "http://www.site.com.br/failure"
+	  }
+	}
+
+	payment = Mercadopago::Checkout.create_preference(access_token, data)
+	
+Como resposta, será recebido um hash como o seguinte:
+
+	{
+		"payment_methods" => {},
+		"init_point" => "https://www.mercadopago.com/mlb/checkout/pay?pref_id=abcdefgh-9999-9999-ab99-999999999999",
+		"collector_id" => 123456789,
+		"back_urls" => {
+			"pending"=> "https://www.site.com.br/pending",
+	    "success"=> "http://www.site.com.br/success",
+			"failure"=> "http://www.site.com.br/failure"
+		},
+		"sponsor_id" => nil,
+		"expiration_date_from" => nil,
+		"additional_info" => "",
+		"marketplace_fee" => 0,
+		"date_created" => "2012-05-07T20:07:52.293-04:00",
+		"subscription_plan_id" => nil,
+		"id"=> "abcdefgh-9999-9999-ab99-999999999999",
+		"expiration_date_to" => nil,
+		"expires" => false,
+		"external_reference" => "OPERATION-ID-1234",
+		"payer" => {
+			"email" => "comprador@email.com.br",
+			"name" => "João",
+			"surname" => "Silva"
+		},
+		"items" => [
+			{
+				"id" => "Código 123",
+				"currency_id" => "BRL",
+				"title" => "Nome produto",
+				"picture_url" => "http://www.site.com.br/image/123.png",
+				"description" => "Descrição produto",
+				"quantity" => 1,
+				"unit_price" => 10.50
+			}
+		],
+		"client_id" => "963",
+		"marketplace" => "NONE"
+	}
+
+### Verificação de status de pagamento
+
+Para consultar o status de um pagamento é necessário ter o id associado a ele, o qual é recebido na IPN do MercadoPago.
+
+	# Use o id do pagamento recebido na IPN do MercadoPago.
+	payment_id = '987654321'
+
+	notification = Mercadopago::Collection.notification(access_token, payment_id)
+	
+Será retornado um hash similar ao seguinte:
+
+	{
+		"collection" => {
+			"id" => 987654321,
+			"site_id" => "MLB",
+			"operation_type" => "regular_payment",
+			"order_id" => nil,
+			"external_reference" => "OPERATION-ID-1234",
+			"status" => "approved",
+			"status_detail" => "approved",
+			"payment_type" => "credit_card",
+			"date_created" => "2012-05-05T14:22:43Z",
+			"last_modified" => "2012-05-05T14:35:13Z",
+			"date_approved" => "2012-05-05T14:22:43Z",
+			"money_release_date" => "2012-05-19T14:22:43Z",
+			"currency_id" => "BRL",
+			"transaction_amount" => 10.50,
+			"shipping_cost" => 0,
+			"total_paid_amount" => 10.50,
+			"finance_charge" => 0,
+			"net_received_amount" => 0,
+			"marketplace" => "NONE",
+			"marketplace_fee" => nil,
+			"reason" => "Nome produto",
+			"payer" => {
+				"id" => 543219876,
+				"first_name" => "João",
+				"last_name" => "Silva",
+				"nickname" => "JOAOSILVA",
+				"phone" => {
+					"area_code" => nil,
+					"number" => "551122334455",
+					"extension" => nil
+				},
+				"email" => "comprador@email.com.br",
+				"identification" => {
+					"type" => nil,
+					"number" => nil
+				}
+			},
+			"collector" => {
+				"id" => 123456789,
+				"first_name" => "Manoel",
+				"last_name" => "Recebedor",
+				"phone" => {
+					"area_code" => nil,
+					"number" => "1122334455",
+					"extension" => nil
+				},
+				"email" => "recebedor@email.com.br",
+				"nickname" => "MANOELRECEBEDOR"
+			}
+		}
+	} 
+
+
+### Erros
+
+Os erros retornados por esta gem são hashes quem contém os dados recebidos dos webservices do MercadoPago.
+
+Por exemplo, caso seja requisitado um access_token através da credenciais inválidas, um hash de erro como o seguinte será retornado:
+
+	{
+		"message" => "client_id[1,234] o client_secret[abcdefghijklmnopqrstuvwxyz] inválidos",
+		"error" => "invalid_client",
+		"status" => 400,
+		"cause" => []
+	}

data/Rakefile

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

data/lib/mercadopago.rb

@@ -0,0 +1,8 @@
+require 'mercadopago/version'
+require 'mercadopago/request'
+require 'mercadopago/authentication'
+require 'mercadopago/checkout'
+require 'mercadopago/collection'
+
+module Mercadopago
+end

data/lib/mercadopago/authentication.rb

@@ -0,0 +1,35 @@
+module Mercadopago
+  
+  module Authentication
+    
+    #
+    # Receives the client credentials and makes a request to oAuth API.
+    # On success, returns a hash with the access data; on failure, returns nil.
+    #
+    # To get your client credentials, access:
+    # https://www.mercadopago.com/mlb/ferramentas/aplicacoes
+    # 
+    # - client_id
+    # - client_secret
+    #
+    def self.access_token(client_id, client_secret)
+      
+      payload = { :grant_type => 'client_credentials', :client_id => client_id, :client_secret => client_secret }
+      headers = { :content_type => 'application/x-www-form-urlencoded', :accept => 'application/json' }
+      
+      Mercadopago::Request.wrap_post('/oauth/token', payload, headers)
+      
+    end
+    
+    #
+    # TODO
+    #
+    def refresh_access_token
+      
+      # TODO
+      
+    end
+    
+  end
+  
+end

data/lib/mercadopago/checkout.rb

@@ -0,0 +1,44 @@
+module Mercadopago
+  
+  module Checkout
+    
+    #
+    # Allows you to configure the checkout process.
+    # Receives an access_token and a prefereces hash and creates a new checkout preference.
+    # Once you have created the checkout preference, you can use the init_point URL
+    # to start the payment flow.
+    #
+    # - access_token: the MercadoPago account associated with this access_token will
+    #                 receive the money from the payment of this checkout preference.
+    # - data: a hash of preferences that will be trasmitted to checkout API.
+    #
+    def self.create_preference(access_token, data)
+      
+      payload = JSON.generate(data)
+      headers = { :content_type => 'application/json', :accept => 'application/json' }
+      
+      Mercadopago::Request.wrap_post("/checkout/preferences?access_token=#{access_token}", payload, headers)
+      
+    end
+    
+    #
+    # TODO
+    #
+    def self.get_preference
+      
+      # TODO
+      
+    end
+    
+    #
+    # TODO
+    #
+    def self.update_preference
+      
+      # TODO
+      
+    end
+    
+  end
+  
+end

data/lib/mercadopago/collection.rb

@@ -0,0 +1,20 @@
+module Mercadopago
+  
+  module Collection
+    
+    #
+    # Receives an access_token and a payment id and retrieves information of the payment.
+    # This is useful, for example, to check the status of a payment.
+    #
+    # - access_token: an access_token of the MercadoPago account associated with the payment to be checked.
+    # - payment_id: the id of the payment to be checked.
+    #
+    def self.notification(access_token, payment_id)
+      
+      Mercadopago::Request.wrap_get("/collections/notifications/#{payment_id}?access_token=#{access_token}", { :accept => 'application/json' })
+      
+    end
+    
+  end
+  
+end

data/lib/mercadopago/request.rb

@@ -0,0 +1,66 @@
+require 'rest-client'
+require 'json'
+
+module Mercadopago
+  
+  module Request
+    
+    #
+    # This URL is the base for all API calls.
+    #
+    MERCADOPAGO_URL = 'https://api.mercadolibre.com'
+
+    #
+    # Makes a POST request to a MercaPago API.
+    #
+    # - path: the path of the API to be called.
+    # - payload: the data to be trasmitted to the API.
+    # - headers: the headers to be transmitted over the HTTP request.
+    #
+    def self.wrap_post(path, payload, headers = {})
+
+      raise ClientError('No data given') if payload.nil? or payload.empty?
+      make_request(:post, path, payload, headers)
+
+    end
+
+    #
+    # Makes a GET request to a MercaPago API.
+    #
+    # - path: the path of the API to be called, including any query string parameters.
+    # - headers: the headers to be transmitted over the HTTP request.
+    #
+    def self.wrap_get(path, headers = {})
+      
+      make_request(:get, path, nil, headers)
+
+    end
+
+    #
+    # Makes a HTTP request to a MercadoPago API.
+    #
+    # - type: the HTTP request type (:get, :post, :put, :delete).
+    # - path: the path of the API to be called.
+    # - payload: the data to be trasmitted to the API.
+    # - headers: the headers to be transmitted over the HTTP request.
+    #
+    def self.make_request(type, path, payload = nil, headers = {})
+      
+      begin
+        args = [type, "#{MERCADOPAGO_URL}#{path}", payload, headers].compact
+        response = RestClient.send *args
+        
+        JSON.load(response)
+      rescue Exception => e
+        JSON.load(e.response)
+      end
+
+    end
+
+
+    class ClientError < Exception
+    end
+    
+  end
+  
+end

data/lib/mercadopago/version.rb

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

data/mercadopago.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mercadopago/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mercadopago"
+  s.version     = Mercadopago::VERSION
+  s.authors     = ["Kauplus Social Commerce"]
+  s.email       = ["suporte@kauplus.com.br"]
+  s.homepage    = "https://github.com/kauplus/mercadopago"
+  s.summary     = %q{Cliente para a API do MercadoPago}
+  s.description = %q{Esta gem é um cliente que permite que desenvolvedores acessem os serviços do http://www.mercadopago.com (MercadoPago)}
+  
+  s.rubyforge_project = "mercadopago"
+
+  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"]
+
+  # specify any dependencies here:
+  s.add_dependency 'json', '1.7.1'
+  s.add_dependency 'rest-client', '1.6.7'
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: mercadopago
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kauplus Social Commerce
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-07 00:00:00.000000000 -03:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &2164866220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 1.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164866220
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &2164857660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *2164857660
+description: Esta gem é um cliente que permite que desenvolvedores acessem os serviços
+  do http://www.mercadopago.com (MercadoPago)
+email:
+- suporte@kauplus.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/mercadopago.rb
+- lib/mercadopago/authentication.rb
+- lib/mercadopago/checkout.rb
+- lib/mercadopago/collection.rb
+- lib/mercadopago/request.rb
+- lib/mercadopago/version.rb
+- mercadopago.gemspec
+has_rdoc: true
+homepage: https://github.com/kauplus/mercadopago
+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: mercadopago
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Cliente para a API do MercadoPago
+test_files: []