mercadopago 2.2.1 → 2.3.0

data/fixtures/vcr_cassettes/login.yml

@@ -0,0 +1,63 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.mercadopago.com/oauth/token
+    body:
+      encoding: UTF-8
+      string: client_id=<CLIENT-ID>&client_secret=<CLIENT-SECRET>&grant_type=client_credentials
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 25 Apr 2016 18:27:43 GMT
+      Content-Type:
+      - application/json;charset=UTF-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept,Accept-Encoding
+      Cache-Control:
+      - max-age=0
+      Etag:
+      - ea81c1fa59f6b789c1d7811bb3497072
+      X-Content-Type-Options:
+      - nosniff
+      X-Frame-Options:
+      - DENY
+      X-Request-Id:
+      - 29adeddd-6421-45c5-a855-0d3bfbb05878
+      X-Xss-Protection:
+      - 1; mode=block
+      Strict-Transport-Security:
+      - max-age=15724800
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Headers:
+      - Content-Type
+      Access-Control-Allow-Methods:
+      - PUT, GET, POST, DELETE, OPTIONS
+      Access-Control-Max-Age:
+      - '86400'
+      X-Libra-Upstreamhost:
+      - 172.16.161.224
+    body:
+      encoding: UTF-8
+      string: '{"access_token":"APP_USR-<CLIENT-ID>-1234567","refresh_token":"TG-2345e6rtyughj7city8d3-1234567","live_mode":true,"user_id":1234567,"token_type":"bearer","expires_in":21600,"scope":"offline_access
+        read write"}'
+    http_version:
+  recorded_at: Mon, 25 Apr 2016 18:27:43 GMT
+recorded_with: VCR 3.0.1

data/fixtures/vcr_cassettes/wrong_login.yml

@@ -0,0 +1,63 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.mercadopago.com/oauth/token
+    body:
+      encoding: UTF-8
+      string: client_id=fake_client_id&client_secret=fake_client_secret&grant_type=client_credentials
+    headers:
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Date:
+      - Mon, 25 Apr 2016 18:27:42 GMT
+      Content-Type:
+      - application/json;charset=UTF-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Vary:
+      - Accept,Accept-Encoding
+      Cache-Control:
+      - max-age=0
+      X-Content-Type-Option:
+      - nosniff
+      X-Frame-Options:
+      - DENY
+      X-Request-Id:
+      - 9e31afa8-3bef-4c21-93ab-0c43a7510d97
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Content-Type-Options:
+      - nosniff
+      Strict-Transport-Security:
+      - max-age=15724800
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Headers:
+      - Content-Type
+      Access-Control-Allow-Methods:
+      - PUT, GET, POST, DELETE, OPTIONS
+      Access-Control-Max-Age:
+      - '86400'
+      X-Libra-Upstreamhost:
+      - 172.16.149.113
+    body:
+      encoding: UTF-8
+      string: '{"message":"Invalid client_id","error":"bad_request","status":400,"cause":{"code":11,"description":"Invalid
+        client_id","data":null}}'
+    http_version: 
+  recorded_at: Mon, 25 Apr 2016 18:27:42 GMT
+recorded_with: VCR 3.0.1

data/fixtures/vcr_cassettes/wrong_token.yml

@@ -0,0 +1,63 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.mercadopago.com/checkout/preferences?access_token=fake_token
+    body:
+      encoding: UTF-8
+      string: "{}"
+    headers:
+      Content-Type:
+      - application/json
+      Accept:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Date:
+      - Mon, 25 Apr 2016 18:27:48 GMT
+      Content-Type:
+      - application/json;charset=UTF-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Cache-Control:
+      - max-age=60, stale-while-revalidate=30, stale-if-error=120
+      Vary:
+      - Accept,Accept-Encoding
+      X-Content-Type-Options:
+      - nosniff
+      - nosniff
+      X-Request-Id:
+      - 0aac4aff-d8c1-44d5-9b56-9770bdb9b923
+      Access-Control-Allow-Origin:
+      - "*"
+      Access-Control-Allow-Headers:
+      - Content-Type
+      Access-Control-Allow-Methods:
+      - PUT, GET, POST, DELETE, OPTIONS
+      Access-Control-Max-Age:
+      - '86400'
+      X-Frame-Options:
+      - DENY
+      X-Xss-Protection:
+      - 1; mode=block
+      - 1; mode=block
+      Strict-Transport-Security:
+      - max-age=15724800
+      - max-age=16070400
+      X-Libra-Upstreamhost:
+      - 172.16.161.224
+    body:
+      encoding: UTF-8
+      string: '{"message":"Malformed access_token: null","error":"bad_request","status":400,"cause":[]}'
+    http_version: 
+  recorded_at: Mon, 25 Apr 2016 18:27:48 GMT
+recorded_with: VCR 3.0.1

data/lib/mercadopago/authentication.rb

@@ -2,6 +2,10 @@ module MercadoPago
 
   module Authentication
 
+    CONTENT_HEADERS = {
+      content_type: 'application/x-www-form-urlencoded',
+      accept: 'application/json'
+    }.freeze
     #
     # Receives the client credentials and makes a request to oAuth API.
     # On success, returns a hash with the access data; on failure, returns nil.
@@ -13,10 +17,12 @@ module MercadoPago
     # - 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' }
+      payload = {
+        grant_type: 'client_credentials',
+        client_id: client_id,
+        client_secret: client_secret }
 
-      MercadoPago::Request.wrap_post('/oauth/token', payload, headers)
+      MercadoPago::Request.wrap_post('/oauth/token', payload, CONTENT_HEADERS)
     end
 
     #
@@ -27,12 +33,13 @@ module MercadoPago
     # - refresh_token
     #
     def self.refresh_access_token(client_id, client_secret, refresh_token)
-      payload = { grant_type: 'refresh_token', client_id: client_id, client_secret: client_secret, refresh_token: refresh_token }
-      headers = { content_type: 'application/x-www-form-urlencoded', accept: 'application/json' }
+      payload = {
+        grant_type: 'refresh_token',
+        client_id: client_id,
+        client_secret: client_secret,
+        refresh_token: refresh_token }
 
-      MercadoPago::Request.wrap_post('/oauth/token', payload, headers)
+      MercadoPago::Request.wrap_post('/oauth/token', payload, CONTENT_HEADERS)
     end
-
   end
-
 end

data/lib/mercadopago/checkout.rb

@@ -14,9 +14,10 @@ module MercadoPago
     #
     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)
+      MercadoPago::Request
+        .wrap_post("/checkout/preferences?access_token=#{access_token}",
+                   payload)
     end
 
     #
@@ -33,7 +34,6 @@ module MercadoPago
     # - preference_id: the payment preference ID
     #
     def self.get_preference(access_token, preference_id)
-      headers = { accept: 'application/json' }
       MercadoPago::Request.wrap_get("/checkout/preferences/#{preference_id}?access_token=#{access_token}")
     end
 
@@ -44,9 +44,10 @@ module MercadoPago
     #
     def self.create_preapproval_payment(access_token, data)
       payload = JSON.generate(data)
-      headers = { content_type: 'application/json', accept: 'application/json' }
 
-      MercadoPago::Request.wrap_post("/preapproval?access_token=#{access_token}", payload, headers)
+      MercadoPago::Request
+        .wrap_post("/preapproval?access_token=#{access_token}",
+                   payload)
     end
 
     #
@@ -56,10 +57,23 @@ module MercadoPago
     # - preapproval_id: the preapproval payment ID
     #
     def self.get_preapproval_payment(access_token, preapproval_id)
-      headers = { accept: 'application/json' }
-      MercadoPago::Request.wrap_get("/preapproval/#{preapproval_id}?access_token=#{access_token}")
+      MercadoPago::Request
+        .wrap_get("/preapproval/#{preapproval_id}?access_token=#{access_token}")
     end
 
-  end
+    #
+    # - access_token: the MercadoPago account associated with this access_token will
+    #                 receive the money from the payment of preapproval payment.
+    # - preapproval_id: the preapproval payment ID
+    #
+    def self.cancel_preapproval_payment(access_token, preapproval_id)
+      payload = JSON.generate(status: :cancelled)
+      headers = { content_type: 'application/json', accept: 'application/json' }
 
+      MercadoPago::Request
+        .wrap_put("/preapproval/#{preapproval_id}?access_token=#{access_token}",
+                  payload,
+                  headers)
+    end
+  end
 end

data/lib/mercadopago/client.rb

@@ -1,4 +1,7 @@
 # encoding: utf-8
+require 'json'
+require 'uri'
+
 module MercadoPago
 
   class AccessError < Exception
@@ -34,7 +37,8 @@ module MercadoPago
     # - client_secret
     #
     def initialize(client_id, client_secret)
-      load_tokens MercadoPago::Authentication.access_token(client_id, client_secret)
+      load_tokens MercadoPago::Authentication.access_token(client_id,
+                                                           client_secret)
     end
 
     #
@@ -56,7 +60,8 @@ module MercadoPago
     # - client_secret
     #
     def refresh_access_token(client_id, client_secret)
-      load_tokens MercadoPago::Authentication.refresh_access_token(client_id, client_secret, @refresh_token)
+      load_tokens(MercadoPago::Authentication
+        .refresh_access_token(client_id, client_secret, @refresh_token))
     end
 
     #
@@ -92,7 +97,18 @@ module MercadoPago
     # - preapproval_id: the id of the preapproval payment preference that will be retrieved.
     #
     def get_preapproval_payment(preapproval_id)
-      MercadoPago::Checkout.get_preapproval_payment(@access_token, preapproval_id)
+      MercadoPago::Checkout.get_preapproval_payment(@access_token,
+                                                    preapproval_id)
+    end
+
+    #
+    # Cancels a recurring payment.
+    #
+    # - preapproval_id: the id of the preapproval payment preference that will be canceled.
+    #
+    def cancel_preapproval_payment(preapproval_id)
+      MercadoPago::Checkout.cancel_preapproval_payment(@access_token,
+                                                       preapproval_id)
     end
 
     #
@@ -115,7 +131,8 @@ module MercadoPago
     # - authorized_id: the id of the recurring payment authorized to be checked.
     #
     def notification_authorized(authorized_id)
-      MercadoPago::Collection.notification_authorized(@access_token, authorized_id)
+      MercadoPago::Collection.notification_authorized(@access_token,
+                                                      authorized_id)
     end
 
     #
@@ -124,7 +141,8 @@ module MercadoPago
     # - preapproval_id: the id of the recurring payment to be checked.
     #
     def notification_preapproval(preapproval_id)
-      MercadoPago::Collection.notification_preapproval(@access_token, preapproval_id)
+      MercadoPago::Collection.notification_preapproval(@access_token,
+                                                       preapproval_id)
     end
 
     #
@@ -136,6 +154,30 @@ module MercadoPago
       MercadoPago::Collection.search(@access_token, search_hash, @sandbox)
     end
 
+    #
+    # Performs a generic GET to the given URL
+    #
+    # - url: the URL to request
+    #
+    def get(url, data = {}, headers = nil)
+      data[:access_token] = @access_token
+      query = URI.encode_www_form data
+
+      MercadoPago::Request.wrap_get("#{url}?{query}", headers)
+    end
+
+    #
+    # Performs a generic POST to the given URL
+    #
+    # - url: the URL to request
+    # - data: the data to send along the request
+    #
+    def post(url, data, headers = nil)
+      payload = JSON.generate(data)
+
+      MercadoPago::Request.wrap_post("#{url}?access_token=#{@access_token}", payload, headers)
+    end
+
     #
     # Private methods.
     #
@@ -156,7 +198,5 @@ module MercadoPago
         raise AccessError, auth['message']
       end
     end
-
   end
-
 end

data/lib/mercadopago/request.rb

@@ -8,10 +8,15 @@ module MercadoPago
     class ClientError < Exception
     end
 
+    CONTENT_HEADERS = {
+      content_type: 'application/json',
+      accept: 'application/json'
+    }.freeze
+
     #
     # This URL is the base for all API calls.
     #
-    MERCADOPAGO_URL = 'https://api.mercadopago.com'
+    MERCADOPAGO_URL = 'https://api.mercadopago.com'.freeze
 
     #
     # Makes a POST request to a MercadoPago API.
@@ -20,18 +25,32 @@ module MercadoPago
     # - 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 = {})
+    def self.wrap_post(path, payload, headers = nil)
       raise ClientError('No data given') if payload.nil? or payload.empty?
+      headers ||= CONTENT_HEADERS
       make_request(:post, path, payload, headers)
     end
 
+    #
+    # Makes a PUT request to a MercadoPago 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_put(path, payload, headers = {})
+      raise ClientError('No data given') if payload.nil? or payload.empty?
+      make_request(:put, path, payload, headers)
+    end
+
     #
     # Makes a GET request to a MercadoPago 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 = {})
+    def self.wrap_get(path, headers = nil)
+      headers ||= CONTENT_HEADERS
       make_request(:get, path, nil, headers)
     end