mercadopago-api 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a264f88b690087c2ea53b0bcb7b42ce594c59f0b
-  data.tar.gz: a8dd0abab34f50e8535c786c233f4c6c9dc8b9ac
+  metadata.gz: d82c002011ea32c8553db542e64a6d07c2b4f972
+  data.tar.gz: bd5e5b5c61cca31dd17cc00762f9b66d365757fa
 SHA512:
-  metadata.gz: 1cd48c663eab6117ce1b8bd80b8017699f64039ddbb27ab3b5dad1158d65367d90d2f85b27e749d0a75c2032fa0703a2c18b195c1b51c6212ca8e6bde88d9bb9
-  data.tar.gz: a253b69eafb095cdd5117982bf2cc85e87aa7aacd94d3a4b06728b3d36c03bba77c7a56802f0884de68954dfdb609859b99e2f4db43aa4b18ee9bf8ff9ee5e27
+  metadata.gz: 7f206660a89b924531a42305a6257df866fb281a179c4927f23227fade0ee6ba3b4d1c7d2a0fefa6eae25b8c31a6e71760bcdb9f7a1344687941f51f6ba293a3
+  data.tar.gz: 41a3716fa1d8f9995434e1a4cfb3793ba67f914c0ebad3e8746cd1ea499bb352d4785afe28f700b32f31f09a5d504a28ba6ceafc2a13242619dd8bd309036902

data/README.md

@@ -1,24 +1,195 @@
 # Mercadopago::Api
 
-TODO: Write a gem description
+This is a Gem to manage mercadopago using ruby, you can use the Gem like a simple Sdk to mercadopago api or like a extension module with another options.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'mercadopago-api'
+	gem 'mercadopago-api'
 
 And then execute:
 
-    $ bundle
+	$ bundle install
 
 Or install it yourself as:
 
-    $ gem install mercadopago-api
+	$ gem install mercadopago-api
 
 ## Usage
 
-TODO: Write usage instructions here
+The gem has to ways of use it, the basic way like a normal SDK
+
+### Usage like SDK
+
+For normal use
+		
+	mp_client = Mercadopago::Sdk.new(client_id, client_secret)
+		
+Accept a optional parameter true or false to activate sandbox mode
+		
+	sandbox_client = Mercadopago::Sdk.new(client_id, client_secret, true)
+
+#### Manage Preference
+
+Create a checkout preference to create a link to mercadopago checkout
+
+	preference = mp_client.create_checkout_preference(data)
+
+Data format is describe [here](http://developers.mercadopago.com/documentacion/api/preferences#glossary)
+
+The minimal hash for data is:
+
+	data = {
+		:items => [
+			{ 
+				:title => "Title of product",
+				:currency_id => "VEF", 
+				:unit_price => 2000.50,
+				:quantity => 2,
+			}
+		]
+	}
+
+The api response wil gave this format, will be a ruby hash and the key values will be like string not like symbols
+
+	{
+		"code": 200,
+		"external_reference": "Reference_1234",
+		"items": [
+			{
+				"id": "Code",
+				"title": "Title of what youre paying for",
+				"description": "Description",
+				"quantity": 1,
+				"unit_price": 50.5,
+				"currency_id": "Currency",
+				"picture_url": "https://www.mercadopago.com/org-img/MP3/home/logomp3.gif"
+			}
+		],																																				    "date_created": "2011-08-16T21:28:42.606-04:00",
+		"id": "preference_identifier",
+		"collector_id": "your_ID_as_seller",
+		"init_point": "checkout-access-URL",
+		"payer": {
+			"email": "payer@email.com",
+			"name": "payer-name",
+			"surname": "payer-surname"
+		},
+		"back_urls": {
+			"success": "https://www.success.com",
+			"failure": "http://www.failure.com",
+			"pending": "http://www.pending.com"
+		},
+		"payment_methods": {
+			"excluded_payment_methods": [
+				{
+				"id": "amex"
+				}
+			],
+			"excluded_payment_types": [
+				{
+					"id": "ticket"
+				}
+			],
+			"installments": 12
+		}	
+	}
+
+If you have to search a previus create preference
+
+	preference = mp_client.get_checkout_preference(preference_id)
+
+If you have to update a Preference
+
+	preference = mp_client.update_checkout_preference(preference_id, new_data)
+
+Get a notification (IPN) payment info, details [here](http://developers.mercadopago.com/documentation/instant-payment-notifications)
+
+	payment = mp_client.get_payment_info(notificaion_payment_id)
+
+Search a payment by payment_id, you can get that when you set your back_urls on checkout Preference, the api will send using query string parameters to your back_url (the api will responde in this case a parameter call collection_id == payment_id)
+
+	payment = mp_client.search_payment(payment_id)
+
+The response for a payment search is:
+
+	{
+		collection: {
+			id: 52675155,
+			site_id: "Country ID",
+			operation_type: "regular_payment",
+			order_id: "4442154",
+			external_reference: "150671633",
+			status: "approved",
+			status_detail: "accredited",
+			payment_type: "ticket",
+			date_created: "2011-09-02T04:00:000Z",
+			last_modified: "2011-09-12T02:52:530Z",
+			date_approved: "2011-09-02T02:49:530Z",
+			money_release_date: "2011-09-09T02:49:530Z",
+			currency_id: "Currency",
+			transaction_amount: 50.5,
+			shipping_cost: 0,
+			finance_charge: null,
+			total_paid_amount: 50.5,
+			net_received_amount: 0,
+			reason: "Title of what youre paying for",
+			payer: {
+				id: 36073078,
+				first_name: "payer-name",
+				last_name: "payer-surname",
+				email: "payer@email.com",
+				nickname: "payer-MercadoLibre's-nickname"
+				phone: {
+					area_code: "011",
+					number: "3486 5039",
+					extension: null
+				}
+			},
+			collector: {
+				id: 68961616,
+				first_name: "collector-name",
+				last_name: "collector-surname",
+				email: "collector@email.com",
+				nickname: "collector-MercadoLibre's-nickname"
+				phone: {
+					area_code: "211",
+					number: "3486 5039",
+					extension: null
+				}
+			}
+		}
+	}
+
+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 )
+	
+	# Search by status
+	search_query = { :status => "approved" }
+	payments = search_payments_where( search_query )
+
+the response of that will be:
+
+	{
+		paging: {
+			total: 76,
+			limit: 2,
+			offset: 10
+		},
+		results: [
+			collention ## one array of collection, see previus response code
+		]
+	}
+
+TODO: refund_payment
+
+TODO: cancel_payment
+
+### Usage like extension 
+
+TODO: write this
 
 ## Contributing
 

data/Rakefile

@@ -20,8 +20,8 @@ end
 desc 'Tags version, pushes to remote, and pushes gem'
 task :release => :build do
 	sh "git tag v#{Mercadopago::VERSION}"
-	sh "git push origin develop"
-	sh "git push origin 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

@@ -51,7 +51,7 @@ module Mercadopago
 			@config = config
 		end
 
-   	def set_credentials(client_id, client_secret)
+		def set_credentials(client_id, client_secret)
 			@credentials = {
 				:client_id => client_id,
 				:client_secret => client_secret

data/lib/mercadopago/sdk.rb

@@ -24,7 +24,7 @@ module Mercadopago
 			}
 			result = Rest::exec(:post, url, data)
 			if result[:code] == 200
-			  @access_token = result["access_token"] 
+				@access_token = result["access_token"] 
 			end
 		end
 

data/lib/mercadopago/version.rb

@@ -1,3 +1,3 @@
 module Mercadopago
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/mercadopago-api.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["higher.vnf@gmail.com"]
   spec.description   = %q{Gem to manage the mercadopago api}
   spec.summary       = %q{This gem manage the Mercadopago api using rest-client and mercadopago rest api}
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/highercomve/mercadopago-api"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -23,5 +23,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-	spec.add_development_dependency 'test'
 end

data/spec/spec_helper.rb

@@ -4,8 +4,8 @@ require 'rspec'
 # setup test environment
 class MercadopagoTest < Mercadopago::Mp	
 	CREDENTIALS = {
-		:client_id => "5453328363694708",
-		:client_secret => "wxO9sB8Mer7wFzrjHUHLHC3iGygc4zgm"
+		:client_id => "your-client-id-on-mercadopago",
+		:client_secret => "your-client-secret-on-mercadopago"
 	}
 
 	CONFIG = {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mercadopago-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Sergio Marin
@@ -80,20 +80,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: test
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Gem to manage the mercadopago api
 email:
 - higher.vnf@gmail.com
@@ -115,7 +101,7 @@ files:
 - mercadopago-api.gemspec
 - spec/mercadopagoapi_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/highercomve/mercadopago-api
 licenses:
 - MIT
 metadata: {}
@@ -135,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
 summary: This gem manage the Mercadopago api using rest-client and mercadopago rest