mercadopago-sdk 0.3.5 → 2.0.1

data/Gemfile.lock

@@ -1,26 +1,54 @@
-PATH
-  remote: .
-  specs:
-    mercadopago-sdk (0.3.3)
-      json
-
 GEM
   remote: https://rubygems.org/
   specs:
-    coderay (1.0.9)
-    json (1.8.3)
-    method_source (0.8.1)
-    pry (0.9.12)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.4)
-    rake (10.0.3)
-    slop (3.4.4)
+    ast (2.4.2)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2021.0225)
+    minitest (5.14.4)
+    netrc (0.11.0)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.3)
+    regexp_parser (2.1.1)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rexml (3.2.4)
+    rubocop (1.11.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.11.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    unicode-display_width (2.0.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  mercadopago-sdk!
-  pry
+  minitest
   rake
+  rest-client
+  rubocop
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Mercado Pago
+
+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

@@ -1,176 +1,87 @@
-# MercadoPago SDK module for Payments integration
+# Mercado Pago SDK for Ruby
 
-* [Install](#install)
-* [Basic checkout](#basic-checkout)
-* [Customized checkout](#custom-checkout)
-* [Generic methods](#generic-methods)
+[![Gem](https://img.shields.io/gem/v/mercadopago-sdk)](https://rubygems.org/gems/mercadopago-sdk)
+[![Gem](https://img.shields.io/gem/dt/mercadopago-sdk)](https://rubygems.org/gems/mercadopago-sdk)
+[![APM](https://img.shields.io/apm/l/vim-mode)](https://github.com/mercadopago/sdk-ruby)
 
-<a name="install"></a>
-## Install
+This library provides developers with a simple set of bindings to help you integrate Mercado Pago API to a website and start receiving payments.
 
-```gem install mercadopago-sdk```
+## 💡 Requirements
 
-<a name="basic-checkout"></a>
-## Basic checkout
+Ruby version **2.3 or greater**.
 
-### Configure your credentials
+## 📲 Installation 
 
-* Get your **CLIENT_ID** and **CLIENT_SECRET** in the following address:
-    * Argentina: [https://www.mercadopago.com/mla/herramientas/aplicaciones](https://www.mercadopago.com/mla/herramientas/aplicaciones)
-    * Brazil: [https://www.mercadopago.com/mlb/ferramentas/aplicacoes](https://www.mercadopago.com/mlb/ferramentas/aplicacoes)
-    * México: [https://www.mercadopago.com/mlm/herramientas/aplicaciones](https://www.mercadopago.com/mlm/herramientas/aplicaciones)
-    * Venezuela: [https://www.mercadopago.com/mlv/herramientas/aplicaciones](https://www.mercadopago.com/mlv/herramientas/aplicaciones)
-    * Colombia: [https://www.mercadopago.com/mco/herramientas/aplicaciones](https://www.mercadopago.com/mco/herramientas/aplicaciones)
-    * Chile: [https://www.mercadopago.com/mlc/herramientas/aplicaciones](https://www.mercadopago.com/mlc/herramientas/aplicaciones)
+Run ```gem install mercadopago-sdk```
 
-```ruby
-require 'mercadopago.rb'
-
-$mp = MercadoPago.new('CLIENT_ID', 'CLIENT_SECRET')
-```
-
-### Preferences
-
-#### Get an existent Checkout preference
-
-```ruby
-preference = $mp.get_preference('PREFERENCE_ID')
-
-puts $preferenceResult
-```
+## 🌟 Getting Started
 
-#### Create a Checkout preference
+First time using Mercado Pago? Create your [Mercado Pago account](https://www.mercadopago.com).
 
-```ruby
+Copy your `Access Token` in the [credentials panel](https://www.mercadopago.com/developers/panel/credentials) and replace the text `YOUR_ACCESS_TOKEN` with it.
 
-preference_data = {
-			"items": [
-				{
-					"title": "testCreate", 
-					"quantity": 1, 
-					"unit_price": 10.2, 
-					"currency_id": "ARS"
-				}
-			]
-		}
-preference = $mp.create_preference(preference_data)
-
-puts preference
-```
+### Simple usage
 
-#### Update an existent Checkout preference
+To generate a `card token` read the [Checkout API](https://www.mercadopago.com/developers/en/guides/online-payments/checkout-api/introduction) documentation.
 
 ```ruby
-preferenceDataToUpdate = Hash["items" => Array(Array["title"=>"testUpdated", "quantity"=>1, "unit_price"=>2])]
-
-preferenceUpdate = $mp.update_preference("PREFERENCE_ID", preferenceDataToUpdate)
-
-puts preferenceUpdate
+require 'mercadopago'
+
+sdk = Mercadopago::SDK.new('YOUR_ACCESS_TOKEN')
+
+payment_data = {
+  transaction_amount: 100,
+  token: 'CARD_TOKEN',
+  description: 'Payment description',
+  payment_method_id: 'visa',
+  installments: 1,
+  payer: {
+    email: 'test_user_123456@testuser.com'
+  }
+}
+result = sdk.payment.create(payment_data)
+payment = result[:response]
+
+puts payment
 ```
 
-### Payments/Collections
-
-#### Search for payments
-
-```ruby    
-filters = Array["id"=>null, "site_id"=>null, "external_reference"=>null]
-
-searchResult = $mp.search_payment(filters)
-
-puts searchResult
-```
+### Per-request configuration
 
-#### Get payment data
+All methods that make API calls accept an optional `RequestOptions` object. This can be used to configure some special options of the request, such as changing credentials or custom headers.
 
 ```ruby
-paymentInfo = $mp.get_payment("ID")
+require 'mercadopago'
 
-puts paymentInfo
-```
-
-### Cancel (only for pending payments)
-
-```ruby
-result = $mp.cancel_payment("ID");
+request_options = Mercadopago::RequestOptions.new(access_token: 'YOUR_ACCESS_TOKEN')
+# ...
 
-// Show result
-puts result
+result = sdk.payment.create(payment_data, request_options: request_options)
+payment = result[:response]
 ```
 
-### Refund (only for accredited payments)
+## 📚 Documentation 
 
-```ruby
-result = $mp.refund_payment("ID");
+Visit our Dev Site for further information regarding:
+ - [APIs](https://www.mercadopago.com/developers/en/reference)
+ - [Checkout Pro](https://www.mercadopago.com/developers/en/guides/online-payments/checkout-pro/introduction)
+ - [Checkout API](https://www.mercadopago.com/developers/en/guides/online-payments/checkout-api/introduction)
+ - [Web Tokenize Checkout](https://www.mercadopago.com/developers/en/guides/online-payments/web-tokenize-checkout/introduction)
 
-// Show result
-puts result
-```
+Check our official code reference to explore all available functionalities.
 
-<a name="custom-checkout"></a>
-## Customized checkout
+## 🤝 Contributing
 
-### Configure your credentials
+All contributions are welcome, ranging from people wanting to triage issues, others wanting to write documentation, to people wanting to contribute code.
 
-* Get your **ACCESS_TOKEN** in the following address:
-    * Argentina: [https://www.mercadopago.com/mla/account/credentials](https://www.mercadopago.com/mla/account/credentials)
-    * Brazil: [https://www.mercadopago.com/mlb/account/credentials](https://www.mercadopago.com/mlb/account/credentials)
-    * Mexico: [https://www.mercadopago.com/mlm/account/credentials](https://www.mercadopago.com/mlm/account/credentials)
-    * Venezuela: [https://www.mercadopago.com/mlv/account/credentials](https://www.mercadopago.com/mlv/account/credentials)
-    * Colombia: [https://www.mercadopago.com/mco/account/credentials](https://www.mercadopago.com/mco/account/credentials)
+Please read and follow our [contribution guidelines](CONTRIBUTING.md). Contributions not following this guidelines will be disregarded. The guidelines are in place to make all of our lives easier and make contribution a consistent process for everyone.
 
-```ruby
-require 'mercadopago.rb'
-
-$mp = MercadoPago.new('ACCESS_TOKEN')
-```
-
-### Create payment
-
-```ruby
-$mp.post ("/v1/payments", payment_data);
-```
-
-### Create customer
+## ❤️ Support
 
-```ruby
-$mp.post ("/v1/customers", Hash["email" => "email@test.com"]);
-```
+If you require technical support, please contact our support team at [developers.mercadopago.com](https://developers.mercadopago.com).
 
-### Get customer
+## 🏻 License
 
-```ruby
-$mp.get ("/v1/customers/CUSTOMER_ID");
 ```
-
-* View more Custom checkout related APIs in Developers Site
-    * Argentina: [https://www.mercadopago.com.ar/developers](https://www.mercadopago.com.ar/developers)
-    * Brazil: [https://www.mercadopago.com.br/developers](https://www.mercadopago.com.br/developers)
-    * Mexico: [https://www.mercadopago.com.mx/developers](https://www.mercadopago.com.mx/developers)
-    * Venezuela: [https://www.mercadopago.com.ve/developers](https://www.mercadopago.com.ve/developers)
-    * Colombia: [https://www.mercadopago.com.co/developers](https://www.mercadopago.com.co/developers)
-
-<a name="generic-methods"></a>
-## Generic methods
-You can access any other resource from the MercadoPago API using the generic methods:
-
-```ruby
-// Get a resource, with optional URL params. Also you can disable authentication for public APIs
-$mp.get ("/resource/uri", [params], [authenticate=true])
-
-// Create a resource with "data" and optional URL params.
-$mp.post ("/resource/uri", data, [params])
-
-// Update a resource with "data" and optional URL params.
-$mp.put ("/resource/uri", data, [params])
-
-// Delete a resource with optional URL params.
-$mp.delete ("/resource/uri", [params])
-```
-
- For example, if you want to get the Sites list (no params and no authentication):
-
-```ruby
-$sites = $mp.get ("/sites", null, false)
-
-puts $sites
+MIT license. Copyright (c) 2021 - Mercado Pago / Mercado Libre
+For more information, see the LICENSE file.
 ```

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
@@ -6,4 +8,4 @@ Rake::TestTask.new do |t|
   t.verbose = true
 end
 
-task :default => :test
+task default: :test

data/docs/CODE_OF_CONDUCT_md.html

@@ -0,0 +1,154 @@
+<!DOCTYPE html>
+
+<html>
+<head>
+<meta charset="UTF-8">
+
+<title>CODE_OF_CONDUCT - RDoc Documentation</title>
+
+<script type="text/javascript">
+  var rdoc_rel_prefix = "./";
+  var index_rel_prefix = "./";
+</script>
+
+<script src="./js/navigation.js" defer></script>
+<script src="./js/search.js" defer></script>
+<script src="./js/search_index.js" defer></script>
+<script src="./js/searcher.js" defer></script>
+<script src="./js/darkfish.js" defer></script>
+
+<link href="./css/fonts.css" rel="stylesheet">
+<link href="./css/rdoc.css" rel="stylesheet">
+
+
+<body id="top" role="document" class="file">
+<nav role="navigation">
+  <div id="project-navigation">
+    <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+  <h2>
+    <a href="./index.html" rel="home">Home</a>
+  </h2>
+
+  <div id="table-of-contents-navigation">
+    <a href="./table_of_contents.html#pages">Pages</a>
+    <a href="./table_of_contents.html#classes">Classes</a>
+    <a href="./table_of_contents.html#methods">Methods</a>
+  </div>
+</div>
+
+    <div id="search-section" role="search" class="project-section initially-hidden">
+  <form action="#" method="get" accept-charset="utf-8">
+    <div id="search-field-wrapper">
+      <input id="search-field" role="combobox" aria-label="Search"
+             aria-autocomplete="list" aria-controls="search-results"
+             type="text" name="search" placeholder="Search" spellcheck="false"
+             title="Type to search, Up and Down to navigate, Enter to load">
+    </div>
+
+    <ul id="search-results" aria-label="Search Results"
+        aria-busy="false" aria-expanded="false"
+        aria-atomic="false" class="initially-hidden"></ul>
+  </form>
+</div>
+
+  </div>
+
+  
+<div class="nav-section">
+  <h3>Table of Contents</h3>
+
+  <ul class="link-list" role="directory">
+    <li><a href="#label-Contributor+Covenant+Code+of+Conduct">Contributor Covenant Code of Conduct</a>
+    <li><a href="#label-Our+Pledge">Our Pledge</a>
+    <li><a href="#label-Our+Standards">Our Standards</a>
+    <li><a href="#label-Our+Responsibilities">Our Responsibilities</a>
+    <li><a href="#label-Scope">Scope</a>
+    <li><a href="#label-Enforcement">Enforcement</a>
+    <li><a href="#label-Attribution">Attribution</a>
+  </ul>
+</div>
+
+
+  <div id="project-metadata">
+    
+<div id="fileindex-section" class="nav-section">
+  <h3>Pages</h3>
+
+  <ul class="link-list">
+    <li><a href="./CODE_OF_CONDUCT_md.html">CODE_OF_CONDUCT</a>
+    <li><a href="./CODING_GUIDELINES_md.html">CODING_GUIDELINES</a>
+    <li><a href="./CONTRIBUTING_md.html">CONTRIBUTING</a>
+    <li><a href="./LICENSE_txt.html">LICENSE</a>
+    <li><a href="./README_md.html">README</a>
+  </ul>
+</div>
+
+  </div>
+</nav>
+
+<main role="main" aria-label="Page CODE_OF_CONDUCT.md">
+
+<h1 id="label-Contributor+Covenant+Code+of+Conduct">Contributor Covenant Code of Conduct<span><a href="#label-Contributor+Covenant+Code+of+Conduct">&para;</a> <a href="#top">&uarr;</a></span></h1>
+
+<h2 id="label-Our+Pledge">Our Pledge<span><a href="#label-Our+Pledge">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<p>In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.</p>
+
+<h2 id="label-Our+Standards">Our Standards<span><a href="#label-Our+Standards">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<p>Examples of behavior that contributes to creating a positive environment include:</p>
+<ul><li>
+<p>Using welcoming and inclusive language</p>
+</li><li>
+<p>Being respectful of differing viewpoints and experiences</p>
+</li><li>
+<p>Gracefully accepting constructive criticism</p>
+</li><li>
+<p>Focusing on what is best for the community</p>
+</li><li>
+<p>Showing empathy towards other community members</p>
+</li></ul>
+
+<p>Examples of unacceptable behavior by participants include:</p>
+<ul><li>
+<p>The use of sexualized language or imagery and unwelcome sexual attention or advances</p>
+</li><li>
+<p>Trolling, insulting/derogatory comments, and personal or political attacks</p>
+</li><li>
+<p>Public or private harassment</p>
+</li><li>
+<p>Publishing others&#39; private information, such as a physical or electronic  address, without explicit permission</p>
+</li><li>
+<p>Other conduct which could reasonably be considered inappropriate in a  professional setting</p>
+</li></ul>
+
+<h2 id="label-Our+Responsibilities">Our Responsibilities<span><a href="#label-Our+Responsibilities">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<p>Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.</p>
+
+<p>Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.</p>
+
+<h2 id="label-Scope">Scope<span><a href="#label-Scope">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<p>This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.</p>
+
+<h2 id="label-Enforcement">Enforcement<span><a href="#label-Enforcement">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<p>Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at danilo.elias@mercadolivre.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.</p>
+
+<p>Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project&#39;s leadership.</p>
+
+<h2 id="label-Attribution">Attribution<span><a href="#label-Attribution">&para;</a> <a href="#top">&uarr;</a></span></h2>
+
+<p>This Code of Conduct is adapted from the <a href="https://contributor-covenant.org">Contributor Covenant</a>, version 1.4, available at <a href="https://contributor-covenant.org/version/1/4/">contributor-covenant.org/version/1/4</a></p>
+
+</main>
+
+
+
+<footer id="validator-badges" role="contentinfo">
+  <p><a href="https://validator.w3.org/check/referer">Validate</a>
+  <p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.3.0.
+  <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
+</footer>
+