mercadopago-api 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 850508386709adf474e9149367fa241642339055
-  data.tar.gz: b35b9fc8a49cfd01fbf66a98cf8f11c038195e6a
+  metadata.gz: 33f9c37574dabe7dd37cda46cb7321ce50a12f53
+  data.tar.gz: a5b67f6ac9501e65f38d70711978f0948be96f6e
 SHA512:
-  metadata.gz: b7856755132044a1d94394ad44531932881d9bc7888b26ac75741f0cd63530bdca689a6e557887952b02e1de4fbba60d75d9bbba53f03b7f85efe93a1dff8253
-  data.tar.gz: b0e2ad2070e22ba11ade231badead7fe6c9fc4d26e6c108f5083db4c1ff37e668b2653dbd1a70ec39f24b3aad0f607d377d68ba4b5777921f6c4d935570e7b37
+  metadata.gz: 34438eaae1f425714f1382ceac07cc3b4d96d955bf7a2a1de768184e433294f17224fe3cf4d81fccbe37e8701e232504c55bc385ad479112762f0849c4e55938
+  data.tar.gz: 33bafaec71860b5c8c3216bd3f08133f16a5f2eb5846a43a9c116185d2ea9fffded4aadee5ed6416e51c82f81678e16045cef49de2c14a82d67fcbc5a3aab06c

data/README.md

@@ -165,41 +165,41 @@ Search a payment by payment_id, you can get that when you set your back_urls on
 The response for a payment search is:
 
 	{
-    id: id-del-pago,
-    site_id: "Identificador de país",
-    date_created: "2011-12-25T12:16:45.000-04:00",
-    date_approved: "2011-12-25T12:16:45.000-04:00",
-    last_modified: "2011-12-25T12:16:55.000-04:00",
-    collector_id: id-del-vendedor,
-    payer: {
-        id: 36073078,
-        email: "payer@email.com"
-    }
-    order_id: "id-orden",
-    external_reference: null,
-    reason: "Título de lo que estás pagando",
-    transaction_amount: 40,
-    currency_id: "Tipo de moneda",
-    total_paid_amount: 40,
-    shipping_cost: 0,
-    net_received_amount: 38,
-    status: "approved",
-    status_detail: "accredited",
-    released: "yes",
-    payment_type: "credit_card",
-    installments: 1,
-    money_release_date: "2011-12-27T12:16:45.000-04:00",
-    operation_type: "regular_payment"
+	id: id-del-pago,
+    	site_id: "Identificador de país",
+    	date_created: "2011-12-25T12:16:45.000-04:00",
+    	date_approved: "2011-12-25T12:16:45.000-04:00",
+    	last_modified: "2011-12-25T12:16:55.000-04:00",
+    	collector_id: id-del-vendedor,
+   		payer: {
+        	id: 36073078,
+        	email: "payer@email.com"
+    	}
+    	order_id: "id-orden",
+    	external_reference: null,
+   		reason: "Título de lo que estás pagando",
+    	transaction_amount: 40,
+    	currency_id: "Tipo de moneda",
+    	total_paid_amount: 40,
+    	shipping_cost: 0,
+    	net_received_amount: 38,
+    	status: "approved",
+    	status_detail: "accredited",
+    	released: "yes",
+    	payment_type: "credit_card",
+    	installments: 1,
+    	money_release_date: "2011-12-27T12:16:45.000-04:00",
+    	operation_type: "regular_payment"
 	}
 
 Search in all your payments given a hash, this hash will set your search parameters. For more details of what parameters you can use to search look [here](http://developers.mercadopago.com/documentation/search-received-payments#search-filters)
 
 	search_query = { :id => "13232333" } 
-	payments = search_payments_where( search_query )
+	payments = mp_client.search_payments_where( search_query )
 	
 	# Search by status
 	search_query = { :status => "approved" }
-	payments = search_payments_where( search_query )
+	payments = mp_client.search_payments_where( search_query )
 
 the response of that will be:
 
@@ -214,10 +214,42 @@ the response of that will be:
 		]
 	}
 
-TODO: refund_payment
+Refund Payment, return the money to the original payer
 
-TODO: cancel_payment
+	refund = mp_client.refund_payment(payment_id)
 
+Cancel Payment
+
+	cancel = mp_client.cancel_payment(payment_id)
+
+Create recurrent payment (preapproval payment)
+
+This method create a preapproval payment (recurrent payment). Recive a data hash with this structure
+
+	data = {
+	  payer_email: String,
+	  back_url: String, 
+	  reason: String,
+	  external_reference: String,
+	  auto_recurring: {
+	    frecuency: Number,
+	    frequency_type: String,  // months or days
+	    transaction_amount: Number,
+	    currency_id: String,
+	    start_date,
+	    end_date
+	  }
+
+For more information about avaliable options go to [here](http://developers.mercadopago.com/documentation/glossary/recurring-payments)
+ 
+	preapproval_payment = mp_client.create_preapproval_payment(data)
+
+Get a recurrent payment information
+
+This method get all the information about a recurrent payments. for more information about what return this method go to [here](http://developers.mercadopago.com/documentation/glossary/recurring-payments#!/get)
+    
+	preapproval_payment = mp_client.get_preapproval_payment(id)
+	
 ### Usage like extension 
 
 TODO: write this

data/Rakefile

@@ -1,27 +1,17 @@
-# require 'bundler/gem_tasks'
+require 'bundler/gem_tasks'
 require 'rake'
 require File.expand_path('../lib/mercadopago/version', __FILE__)
 
 desc 'Run Tests'
 task :test do
-	sh "rspec"
-end
-
-desc 'Builds the gem'
-task :build do
-	  sh "gem build mercadopago-api.gemspec"
-end
-
-desc 'Builds and installs the gem'
-task :install => :build do
-	  sh "gem install mercadopago-api-#{Mercadopago::VERSION}"
+  sh "rspec"
 end
 
 desc 'Tags version, pushes to remote, and pushes gem'
 task :release => :build do
-	sh "git tag v#{Mercadopago::VERSION}"
-	sh "git push github master"
-	sh "git push github v#{Mercadopago::VERSION}"
-	sh "gem push mercadopago-api-#{Mercadopago::VERSION}.gem"
+  sh "git tag v#{Mercadopago::VERSION}"
+  sh "git push github master"
+  sh "git push github v#{Mercadopago::VERSION}"
+  sh "gem push mercadopago-api-#{Mercadopago::VERSION}.gem"
 end
 

data/lib/mercadopago-api.rb

@@ -1,4 +1,3 @@
 # Compatibility to autorequire schemes
-
-require File.dirname(__FILE__) + "/mercadopagoapi.rb"
+require "mercadopagoapi"
 

data/lib/mercadopago/api.rb

@@ -1,69 +1,69 @@
-require_relative "./sdk"
-
+require "mercadopago/sdk"
+:w
 module Mercadopago
-	module Api
-		attr_writer :credentials, :preference
-		attr_reader :sdk
-		
-		def checkout_link(data)
-			preference = sdk.create_checkout_preference(data, config[:excluded_payment_methods])
-			if config[:sandbox]
-				preference['sandbox_init_point']
-			else
-				preference['init_point']
-			end
-		end
+  module Api
+    attr_writer :credentials, :preference
+    attr_reader :sdk
+    
+    def checkout_link(data)
+      preference = sdk.create_checkout_preference(data, config[:excluded_payment_methods])
+      if config[:sandbox]
+        preference['sandbox_init_point']
+      else
+        preference['init_point']
+      end
+    end
 
-		def find_payment(payment_id)
-			if config[:sandbox]
-				result = sdk.search_payments_where({:id => payment_id})['results'].first
-			else
-				result = sdk.search_payment(payment_id)
-			end
-			result
-		end
+    def find_payment(payment_id)
+      if config[:sandbox]
+        result = sdk.search_payments_where({:id => payment_id})['results'].first
+      else
+        result = sdk.search_payment(payment_id)
+      end
+      result
+    end
 
-		def find_payment_with_notification(payment_id)
-			result = sdk.get_payment_info(payment_id)
-			payment = result['collection']
-			payment[:code] = result[:code]
-		end
+    def find_payment_with_notification(payment_id)
+      result = sdk.get_payment_info(payment_id)
+      payment = result['collection']
+      payment[:code] = result[:code]
+    end
 
-		def sdk
-			@sdk ||= Sdk.new(credentials[:client_id], credentials[:client_secret], config[:sandbox])
-		end
+    def sdk
+      @sdk ||= Sdk.new(credentials[:client_id], credentials[:client_secret], config[:sandbox])
+    end
 
-		def credentials
-			if @credentials.empty?
-				raise "Please set yours Credentials, using set_credentials"
-			else
-				@credentials
-			end
-		end
+    def credentials
+      if @credentials.empty?
+        raise "Please set yours Credentials, using set_credentials"
+      else
+        @credentials
+      end
+    end
 
-		def preference
-			if @preference.nil?
-				raise "You have to create or get a preference first" 
-			else
-				@preference
-			end
-		end
+    def preference
+      if @preference.nil?
+        raise "You have to create or get a preference first" 
+      else
+        @preference
+      end
+    end
 
-		def config
-			@config || {}
-		end
+    def config
+      @config || {}
+    end
 
-		def config=(config)
-			@config = config
-		end
+    def config=(config)
+      @config = config
+    end
 
-		def set_credentials(client_id, client_secret)
-			@credentials = {
-				:client_id => client_id,
-				:client_secret => client_secret
-			}
-		end
-	end
+    def set_credentials(client_id, client_secret)
+      @credentials = {
+        :client_id => client_id,
+        :client_secret => client_secret
+      }
+    end
+  end
 
 end
-	
+  

data/lib/mercadopago/sdk.rb

@@ -1,128 +1,162 @@
-require 'rubygems'
 require 'rest_client'
 require 'json/ext'
 require 'uri'
 
 module Mercadopago
-	class Sdk
-
-		attr_accessor :client_id, :client_secret, :sandbox, :checkout
-		attr_writer :access_token
-		
-		def initialize(client_id, client_secret, sandbox=false)
-			@client_id = client_id 
-			@client_secret = client_secret
-			@sandbox = sandbox
-		end
-
-		def get_access_token
-			url = "/oauth/token"
-			data = {
-				:grant_type => "client_credentials",
-				:client_id => @client_id,
-				:client_secret => @client_secret
-			}
-			result = Rest::exec(:post, url, data)
-			if result[:code] == 200
-				@access_token = result["access_token"] 
-			end
-		end
-
-		def access_token
-			@access_token || get_access_token
-		end
-
-		def create_checkout_preference(data, exclude_methods=nil)
-			unless exclude_methods.nil?
-				data[:payment_methods] = { 
-					:excluded_payment_methods => exclude_methods
-				}
-			end
-			url = "/checkout/preferences?access_token="+access_token
-			response = Rest::exec(:post, url, data, true)
-			if response[:code] = 201
-				@checkout = response
-			else
-				response
-			end
-		end
-
-		def update_checkout_preference(preference_id, data)
-			url = sandbox_prefix + "/checkout/preferences/#{preference_id}?access_token=#{access_token}"
-			Rest::exec(:put, url, data, true)
-		end
-
-		def get_checkout_preference(id)
-			url = sandbox_prefix + "/checkout/preferences/#{preference_id}?access_token=#{access_token}"
-			Rest::exec(:get, url, nil, true)
-		end
-
-		def get_payment_info(notification_id)
-			url = sandbox_prefix + "/collections/notifications/#{notification_id}?access_token=#{access_token}"
-			Rest::exec(:get, url, nil, true)
-		end
-
-		def search_payment(payment_id)
-			url = sandbox_prefix + "/collections/#{payment_id}?access_token=#{access_token}"
-			Rest::exec(:get, url, nil, true)
-		end
-
-		def search_payments_where(params)
-			url = sandbox_prefix + "/collections/search"
-			params[:access_token] = access_token 
-			Rest::exec(:get, url, { :params => params })		
-		end	
-
-		def create_test_user(site_id)
-			url = "users/test_user?access_token=#{access_token}"
-			Rest::exec(:post, url, { :site_id => site_id }, true )
-		end
-
-		def refund_payment(payment_id)
-			url = "/collections/#{payment_id}?access_token=#{access_token}"
-			Rest::exec(:put, url, {:status => "refunded"}, true )
-		end
-
-		def cancel_payment(payment_id)
-			url = "/collections/#{payment_id}?access_token=#{access_token}"
-			Rest::exec(:put, url, {:status => "cancelled"}, true )
-		end
-
-		def sandbox_prefix 
-			@sandbox ? "/sandbox":""
-		end
-
-	end
-
-	module Rest
-		URL = "https://api.mercadolibre.com/"
-		def exec(method, url, data=nil, json=false)	
-			url = uri(url)
-			if !data.nil? and json
-				RestClient.send(method, url, data.to_json,  :content_type => :json, :accept => :json) do |response, request, result|
-					build_response(response)
-				end
-			elsif data.nil? and json
-				RestClient.send(method, url, :accept => :json) do |response, request, result|
-					build_response(response)
-				end
-			else 
-				RestClient.send(method, url, data) do |response, request, result|
-					build_response(response)
-				end
-			end	
-		end
-		
-		def build_response( response )
-			r = JSON.parse(response.force_encoding("UTF-8"))
-			r[:code] = response.code
-			return r
-		end
-
-		def uri(url)
-			URI.join(URL, url).to_s
-		end
-		
-		module_function :exec, :uri, :build_response
-	end
+  class Sdk
+
+    attr_accessor :client_id, :client_secret, :sandbox
+    attr_writer :access_token
+    
+    def initialize(client_id, client_secret, sandbox=false)
+      @client_id = client_id 
+      @client_secret = client_secret
+      @sandbox = sandbox
+    end
+
+    def get_access_token
+      url = "/oauth/token"
+      data = {
+        :grant_type => "client_credentials",
+        :client_id => @client_id,
+        :client_secret => @client_secret
+      }
+      result = Rest::exec(:post, url, data)
+      if result[:code] == 200
+        @access_token = result["access_token"] 
+      end
+    end
+
+    def access_token
+      @access_token || get_access_token
+    end
+
+    def create_checkout_preference(data, exclude_methods=nil)
+      unless exclude_methods.nil?
+        data[:payment_methods] = { 
+          :excluded_payment_methods => exclude_methods
+        }
+      end
+      url = "/checkout/preferences?access_token="+access_token
+      Rest::exec(:post, url, data, true)
+    end
+
+    def update_checkout_preference(preference_id, data)
+      url = build_url "/checkout/preferences/#{preference_id}"
+      Rest::exec(:put, url, data, true)
+    end
+
+    def get_checkout_preference(id)
+      url = build_url "/checkout/preferences/#{preference_id}"
+      Rest::exec(:get, url, nil, true)
+    end
+
+    # This method create a preapproval payment (recurrent payment)
+    # Recive a data hash with this structure:
+    #
+    # data = {
+    #   payer_email: String,
+    #   back_url: String, 
+    #   reason: String,
+    #   external_reference: String,
+    #   auto_recurring: {
+    #     frecuency: Number,
+    #     frequency_type: String,  // months or days
+    #     transaction_amount: Number,
+    #     currency_id: String,
+    #     start_date,
+    #     end_date
+    #   }
+    #
+    # For more information about avaliable options go to 
+    # http://developers.mercadopago.com/documentation/glossary/recurring-payments
+   def create_preapproval_payment(data)
+      url = build_url "/preapproval"
+      Rest::exec(:post, url, data, true)
+    end
+
+    # This method get all the information about a recurrent payment
+    # for information about what return this method go to 
+    # http://developers.mercadopago.com/documentation/glossary/recurring-payments#!/get
+    def get_preapproval_payment(id)
+      url = build_url "/preapproval/#{id}"
+      Rest::exec(:get, url)
+    end
+
+    def get_payment_info(notification_id)
+      url = build_url "/collections/notifications/#{notification_id}"
+      Rest::exec(:get, url, nil, true)
+    end
+
+    def search_payment(payment_id)
+      url = build_url "/collections/#{payment_id}"
+      Rest::exec(:get, url, nil, true)
+    end
+
+    def search_payments_where(params)
+      url = build_url "/collections/search", false
+      params[:access_token] = access_token 
+      Rest::exec(:get, url, { :params => params })		
+    end 
+
+    def create_test_user(site_id)
+      url = build_url "users/test_user"
+      Rest::exec(:post, url, { :site_id => site_id }, true )
+    end
+
+    def refund_payment(payment_id)
+      url = build_url "/collections/#{payment_id}"
+      Rest::exec(:put, url, {:status => "refunded"}, true )
+    end
+
+    def cancel_payment(payment_id)
+      url = build_url "/collections/#{payment_id}"
+      Rest::exec(:put, url, {:status => "cancelled"}, true )
+    end
+
+    def build_url(action, access_token=true)
+      if access_token
+        sandbox_prefix + action + "?access_token=#{access_token}"
+      else
+        sandbox_prefix + action
+      end
+    end
+
+    def sandbox_prefix 
+      @sandbox ? "/sandbox":""
+    end
+
+  end
+
+  module Rest
+    URL = "https://api.mercadolibre.com/"
+    def exec(method, url, data=nil, json=false) 
+      url = uri(url)
+      if !data.nil? and json
+        RestClient.send(method, url, data.to_json,  :content_type => :json, :accept => :json) do |response, request, result|
+          build_response(response)
+        end
+      elsif data.nil? and json
+        RestClient.send(method, url, :accept => :json) do |response, request, result|
+          build_response(response)
+        end
+      else 
+        RestClient.send(method, url, data) do |response, request, result|
+          build_response(response)
+        end
+      end 
+    end
+    
+    def build_response( response )
+      r = JSON.parse(response.force_encoding("UTF-8"))
+      r[:code] = response.code
+      return r
+    end
+
+    def uri(url)
+      URI.join(URL, url).to_s
+    end
+    
+    module_function :exec, :uri, :build_response
+  end
 end

data/lib/mercadopago/version.rb

@@ -1,3 +1,3 @@
 module Mercadopago
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/mercadopagoapi.rb

@@ -1,13 +1,13 @@
-require_relative "./mercadopago/api"
-require_relative "./mercadopago/version"
+require "mercadopago/api"
+require "mercadopago/version"
 
 module Mercadopago
-	class Mp
-		include Api
+  class Mp
+    include Api
 
-		def initialize(client_id, client_secret)
-			set_credentials(client_id, client_secret)
-		end
-		
-	end
+    def initialize(client_id, client_secret)
+      set_credentials(client_id, client_secret)
+    end
+    
+  end
 end

data/spec/mercadopago_spec.rb

@@ -1,54 +1,54 @@
 require 'spec_helper'
 
 describe 'Test Mercadopago Api Object' do
-	before do
-		@credenciales = MercadopagoTest::CREDENTIALS
-	end
+  before do
+    @credenciales = MercadopagoTest::CREDENTIALS
+  end
 
-	it "The object must be a dependecy of Mercadopago::Mp" do
-		api = MercadopagoTest.new(@credenciales[:client_id], @credenciales[:client_secret])
-		api.should be_kind_of(Mercadopago::Mp)
-	end
+  it "The object must be a dependecy of Mercadopago::Mp" do
+    api = MercadopagoTest.new(@credenciales[:client_id], @credenciales[:client_secret])
+    api.should be_kind_of(Mercadopago::Mp)
+  end
 
-	it "SDK method initialize" do 
-		sdk = Mercadopago::Sdk.new @credenciales[:client_id], @credenciales[:client_secret]
-		sdk.should be_kind_of(Mercadopago::Sdk)
-	end
+  it "SDK method initialize" do 
+    sdk = Mercadopago::Sdk.new @credenciales[:client_id], @credenciales[:client_secret]
+    sdk.should be_kind_of(Mercadopago::Sdk)
+  end
 
 end
 
 describe 'Mercado Pago api' do
-	before do
-		@credenciales = MercadopagoTest::CREDENTIALS
-		@api = MercadopagoTest.new(@credenciales[:client_id], @credenciales[:client_secret])
-	end
-
-	it "The object must initialize only with credentials" do
-		@api.should be_kind_of(Mercadopago::Mp)
-		@api.credentials.should == @credenciales
-	end
-
-	it "The sdk most have a token to work" do
-		@api.sdk.access_token.should_not be_nil
-	end
-
-	it "The object most accept config values" do
-		config = { :currency_id => "VEF", :sandbox => true }
-		@api.config = config 
-		@api.config.should == config
-	end
-
-	it "The preference need to be a mercadopago api preference hash, respond 200" do
-		true
-	end
-
-	it "Search a payment and return only the collection" do
-		payment_id = "660685397121"
-		payment = @api.find_payment(payment_id)
-		if payment
-			payment.should == @api.sdk.search_payment(payment_id)
-		else
-			payment[:code].should == 404
-		end
-	end
-end
+  before do
+    @credenciales = MercadopagoTest::CREDENTIALS
+    @api = MercadopagoTest.new(@credenciales[:client_id], @credenciales[:client_secret])
+  end
+
+  it "The object must initialize only with credentials" do
+    @api.should be_kind_of(Mercadopago::Mp)
+    @api.credentials.should == @credenciales
+  end
+
+  it "The sdk most have a token to work" do
+    @api.sdk.access_token.should_not be_nil
+  end
+
+  it "The object most accept config values" do
+    config = { :currency_id => "VEF", :sandbox => true }
+    @api.config = config 
+    @api.config.should == config
+  end
+
+  it "The preference need to be a mercadopago api preference hash, respond 200" do
+    true
+  end
+
+  it "Search a payment and return only the collection" do
+    payment_id = "660685397121"
+    payment = @api.find_payment(payment_id)
+    if payment
+      payment.should == @api.sdk.search_payment(payment_id)
+    else
+      payment[:code].should == 404
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,15 +2,16 @@ require File.join(File.dirname(__FILE__), '../lib/', 'mercadopagoapi.rb')
 require 'rspec'
 
 # setup test environment
-class MercadopagoTest < Mercadopago::Mp	
-	CREDENTIALS = {
-		:client_id => "your-client-id",
-		:client_secret => "your-client-secret"
-	}
 
-	CONFIG = {
-		:currency_id => "VEF",
-		:sandbox => false
-	}
+class MercadopagoTest < Mercadopago::Mp 
+  CREDENTIALS = {
+    :client_id => "your-client-id",
+    :client_secret => "your-client-secret"
+  }
+
+  CONFIG = {
+    :currency_id => "VEF",
+    :sandbox => false
+  }
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mercadopago-api
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Sergio Marin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-11 00:00:00.000000000 Z
+date: 2013-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -121,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.1.0
 signing_key: 
 specification_version: 4
 summary: This gem manage the Mercadopago api using rest-client and mercadopago rest