mercadopago 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac03eabc246d2feb42e79e390d21dcf3ecca5d89
-  data.tar.gz: e33fdd761bf7100df62e782d66d693d3026c6135
+  metadata.gz: 5e1562b1e4de4f9ed87e54dda09f63f443a4d669
+  data.tar.gz: 374a4a7099b084264fb77ca72ecefdbea2f4724d
 SHA512:
-  metadata.gz: eb8dd18062cb47b2cdf37404f3c21814a3ae09f0175558df86fbf5fe6c97c5a8bdce2e287155805958010025b08cf562616556670b916ce99b99dc6eb66c6f68
-  data.tar.gz: b4b837900a8f2f2f698ea033de72e614ac96324cb82b2ff08188e1d38eb1349510bc80b8cba4e43bf486cad37d651b8e1ab03e0792ad419a54155a1d619709a7
+  metadata.gz: fc95d5f6f99a7cb3269b463b992e9f090ab6c5a0e0f9968308dcecb5ff3738c4ecbcc2e1e37e444deed6fc0b361e4d3f451adca5bd5bbd9b816cfb41e787d384
+  data.tar.gz: b74e252e8e6e81eb0e43373ab1538a6b24c20c1d7fcba4a517b9d9348427020c7ce86a1e140f8b9658cad1b3b8a84abea3de23d2b8ccdf0b82fb90da40d34e96

data/.gitignore

@@ -9,3 +9,6 @@ pkg/*
 ## TEXTMATE
 *.tmproj
 tmtags
+
+## rvm/rbenv
+.ruby-version

data/README.md

@@ -16,7 +16,7 @@ You can read the documentation of the MercadoPago API here:
 Installation
 ------------
 
-mercadopago 2.0.0 needs Ruby 1.9. Version 1.0.2 runs fine with Ruby 1.8.
+mercadopago 2.0.0+ needs Ruby 1.9+. Version 1.0.2 runs fine with Ruby 1.8.
 
 To install the last version of the gem:
 
@@ -283,6 +283,114 @@ And the parameters thay could be used in the search hash are:
         recurring_payment: Active subscription recurring payment.
         subscription_payment: Subscription fee.
 
+### Recurring Payment Creation
+
+Your request will need a hash to explain what the recurring payment is for. For example:
+
+    data = {
+      payer_email:        "xxx@test.com",
+      back_url:           "http://www.site.com/return",
+      reason:             "Monthly Magazine",
+      external_reference: "OPERATION-ID-1234",
+      auto_recurring: {
+        frequency:          1,
+        frequency_type:     "months",
+        transaction_amount: 12.55,
+        currency_id:        "BRL"
+      }
+    }
+
+If everything worked out alright, you will get a response like this:
+
+    {
+       "id"                 => "f8ad8asd8asd98asd89add980",
+       "payer_id"           => 131231333,
+       "payer_email"        => "xxx@test.com",
+       "back_url"           => "http://www.site.com/return",
+       "collector_id"       => 3131231231,
+       "application_id"     => 83818921839,
+       "status"             => "authorized",
+       "reason"             => "Monthly Magazine",
+       "external_reference" => "OPERATION-ID-1234",
+       "date_created"       => "2014-08-03T20:47:53.970-04:00",
+       "last_modified"      => "2014-08-03T20:51:00.264-04:00",
+       "init_point"         => "https://www.mercadopago.com/mlb/debits/new?preapproval_id=8ad8asd8ada8da8dad88sa",
+       "auto_recurring" => {
+        "frequency"          => 1,
+        "frequency_type"     => "months",
+        "transaction_amount" => 12.55,
+        "currency_id"        => "BRL"
+       }
+    }
+
+
+### Recurring Payment Status Verification Next Recurring Payments by IPN
+
+To check the recurring payment status you will need the preapproval ID next recurring payments. Only then you can call the [MercadoPago IPN](https://developers.mercadopago.com/beta/documentacao/notificacoes-de-pagamentos#!/get-preapproval).
+
+    # Use the preapproval ID received on the IPN.
+    preapproval_id = '987654321'
+
+    notification = mp_client.notification_authorized(preapproval_id)
+
+You will get a response like this one:
+
+Status code: 200 OK
+
+    {
+        "preapproval_id":     "preapproval_id",
+        "id":                 "authorized_payment_id",
+        "type":               "online",
+        "status":             "processed",
+        "date_created":       "2014-05-22T11:53:37.074-04:00",
+        "last_modified":      "2014-05-22T11:53:37.074-04:00",
+        "transaction_amount": 150,
+        "currency_id":        "BRL",
+        "payment":
+        {
+            "id":            "payment_id",
+            "status":        "approved",
+            "status_detail": "accredited"
+        }
+    }
+
+### Recurring Payment Status Verification by IPN
+
+To check the recurring payment status you will need the preapproval ID. Only then you can call the [MercadoPago IPN](https://developers.mercadopago.com/beta/documentacao/notificacoes-de-pagamentos#!/get-preapproval).
+
+    # Use the preapproval ID received on the IPN.
+    preapproval_id = '987654321'
+
+    notification = mp_client.notification_preapproval(preapproval_id)
+
+You will get a response like this one:
+
+Status code: 200 OK
+
+    {
+      "id":                 "preapproval_id",
+      "payer_id":           12345,
+      "payer_email":        "payeremail@email.com",
+      "back_url":           "https://www.mysite.com/afterAuth",
+      "collector_id":       12345,
+      "application_id":     10648,
+      "status":             "authorized",
+      "init_point":         "https://www.mercadopago.com/mlb/debits/new?preapproval_id=preapproval_id",
+      "sandbox_init_point": "https://www.mercadopago.com/mlb/debits/new?preapproval_id=preapproval_id",
+      "external_reference": "OP-1234",
+      "reason":             "Detailed description about your service",
+      "auto_recurring": {
+        "frequency":          1,
+        "frequency_type":     "months",
+        "transaction_amount": 60,
+        "currency_id":        "BRL"
+      },
+      "date_created":  "2012-08-31T11:50:26.648-04:00",
+      "last_modified": "2012-08-31T11:50:26.648-04:00"
+    }
+
+
+
 ### Errors
 
 Errors will also be hashes with status code, message and error key.
@@ -305,6 +413,10 @@ This gem has tests for a few methods. To check if it is working properly, just r
 Changelog
 ---------
 
+2.1.0 (thanks jamessonfaria)
+
+Added functionality to create and get recurring payments. Also added support for recurring payments notification.
+
 2.0.2
 
 Request uses Faraday HTTP client instead of RestClient for better SSL support.
@@ -336,4 +448,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 
 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.
+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/lib/mercadopago.rb

@@ -3,6 +3,7 @@ require 'mercadopago/request'
 require 'mercadopago/authentication'
 require 'mercadopago/checkout'
 require 'mercadopago/collection'
+require 'mercadopago/merchant_order'
 require 'mercadopago/client'
 
 module MercadoPago

data/lib/mercadopago/checkout.rb

@@ -19,6 +19,14 @@ module MercadoPago
       MercadoPago::Request.wrap_post("/checkout/preferences?access_token=#{access_token}", payload, headers)
     end
 
+    #
+    # TODO
+    #
+    def self.update_preference
+      # TODO
+    end
+
+    #
     # Returns the hash with the details of certain payment preference.
     #
     # - access_token: the MercadoPago account access token
@@ -30,10 +38,26 @@ module MercadoPago
     end
 
     #
-    # TODO
+    # - access_token: the MercadoPago account associated with this access_token will
+    #                 receive the money from the payment of preapproval payment.
+    # - data: a hash of preferences that will be trasmitted to checkout API.
     #
-    def self.update_preference
-      # TODO
+    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)
+    end
+
+    #
+    # Returns the hash with the details of certain preapproval payment.
+    #
+    # - access_token: the MercadoPago account access token
+    # - 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}")
     end
 
   end

data/lib/mercadopago/client.rb

@@ -64,12 +64,53 @@ module MercadoPago
     end
 
     #
-    # Retrieves the latest information about a payment.
+    # Creates a recurring payment.
     #
-    # - payment_id: the id of the payment to be checked.
+    # - data: contains the data according to the recurring payment that will be created.
     #
-    def notification(payment_id)
-      MercadoPago::Collection.notification(@access_token, payment_id)
+    def create_preapproval_payment(data)
+      MercadoPago::Checkout.create_preapproval_payment(@access_token, data)
+    end
+
+    #
+    # Returns the recurring payment.
+    #
+    # - 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)
+    end
+
+    #
+    # Retrieves the latest information about a payment or a merchant order.
+    #
+    # - entity_id: the id of the entity (paymento or merchant order) to be checked.
+    #
+    def notification(entity_id, topic = 'payment')
+      case topic.to_s
+      when 'merchant_order'
+        MercadoPago::MerchantOrder.notification(@access_token, entity_id)
+      else # 'payment'
+        MercadoPago::Collection.notification(@access_token, entity_id)
+      end
+    end
+
+    #
+    # Retrieves the latest information about the recurring payment after authorized.
+    #
+    # - 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)
+    end
+
+    #
+    # Retrieves the latest information about the recurring payment.
+    #
+    # - preapproval_id: the id of the recurring payment to be checked.
+    #
+    def notification_preapproval(preapproval_id)
+      MercadoPago::Collection.notification_preapproval(@access_token, preapproval_id)
     end
 
     #
@@ -104,4 +145,4 @@ module MercadoPago
 
   end
 
-end
+end

data/lib/mercadopago/collection.rb

@@ -13,6 +13,22 @@ module MercadoPago
       MercadoPago::Request.wrap_get("/collections/notifications/#{payment_id}?access_token=#{access_token}", { accept: 'application/json' })
     end
 
+    #
+    # - access_token: an access_token of the MercadoPago account associated with the payment to be checked.
+    # - authorized_id: the id of the authorized payment to be checked.
+    #
+    def self.notification_authorized(access_token, authorized_id)
+      MercadoPago::Request.wrap_get("/authorized_payments/#{authorized_id}?access_token=#{access_token}", { accept: 'application/json' })
+    end
+
+    #
+    # - access_token: an access_token of the MercadoPago account associated with the payment to be checked.
+    # - preapproval_id: the id of the recurring payment to be checked.
+    #
+    def self.notification_preapproval(access_token, preapproval_id)
+      MercadoPago::Request.wrap_get("/preapproval/#{preapproval_id}?access_token=#{access_token}", { accept: 'application/json' })
+    end
+
     #
     # Receives an access_token and a search_hash and returns matching payments, according to the search params.
     #

data/lib/mercadopago/merchant_order.rb

@@ -0,0 +1,17 @@
+module MercadoPago
+
+  module MerchantOrder
+
+    #
+    # Receives an access_token and a merchant order id and retrieves information of the order.
+    #
+    # - access_token: an access_token of the MercadoPago account associated with the payment to be checked.
+    # - merchant_order_id: the id of the order to be checked.
+    #
+    def self.notification(access_token, merchant_order_id)
+      MercadoPago::Request.wrap_get("/merchant_orders/#{merchant_order_id}?access_token=#{access_token}", { accept: 'application/json' })
+    end
+
+  end
+
+end

data/lib/mercadopago/request.rb

@@ -56,9 +56,12 @@ module MercadoPago
 
       JSON.load(response.body)
     rescue Exception => e
-      JSON.load(e.response)
+      if e.respond_to?(:response)
+        JSON.load(e.response)
+      else
+        raise e
+      end
     end
-
   end
 
 end

data/lib/mercadopago/version.rb

@@ -1,3 +1,3 @@
 module MercadoPago
-  VERSION = "2.0.2"
+  VERSION = "2.1.0"
 end

data/mercadopago.gemspec

@@ -5,6 +5,7 @@ require "mercadopago/version"
 Gem::Specification.new do |s|
   s.name        = "mercadopago"
   s.version     = MercadoPago::VERSION
+  s.licenses    = ['MIT']
   s.authors     = ["Kauplus Social Commerce", "Ombu Shop, Tu Tienda Online"]
   s.email       = ["suporte@kauplus.com.br"]
   s.homepage    = "https://github.com/kauplus/mercadopago"
@@ -20,7 +21,7 @@ Gem::Specification.new do |s|
 
   # specify any dependencies here:
   s.add_dependency 'json', '>= 1.4.6'
-  s.add_dependency 'faraday', '0.9.0'
+  s.add_dependency 'faraday', '>= 0.9.0'
   s.add_development_dependency 'pry'
   s.add_development_dependency 'debugger'
 end

data/test/test_mercado_pago.rb

@@ -95,14 +95,22 @@ class TestMercadoPago < MiniTest::Unit::TestCase
     assert_equal "https://www.mercadopago.com/mlb/checkout/pay?pref_id=#{pref_id}", response['init_point']
   end
 
-  def test_that_client_can_get_notification
-    payment_id = 460494008
+  def test_that_client_can_get_payment_notification
+    payment_id = 849707350
     mp_client = MercadoPago::Client.new(CREDENTIALS[:client_id], CREDENTIALS[:client_secret])
 
     response = mp_client.notification(payment_id)
     assert_equal payment_id, response['collection']['id']
   end
 
+  def test_that_client_can_get_merchant_order_notification
+    payment_id = 61166827
+    mp_client = MercadoPago::Client.new(CREDENTIALS[:client_id], CREDENTIALS[:client_secret])
+
+    response = mp_client.notification(payment_id, 'merchant_order')
+    assert_equal payment_id, response['id']
+  end
+
   def test_that_client_can_search
     mp_client = MercadoPago::Client.new(CREDENTIALS[:client_id], CREDENTIALS[:client_secret])
     response = mp_client.search(status: :pending)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mercadopago
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Kauplus Social Commerce
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-03 00:00:00.000000000 Z
+date: 2014-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -29,14 +29,14 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
@@ -84,12 +84,14 @@ files:
 - lib/mercadopago/checkout.rb
 - lib/mercadopago/client.rb
 - lib/mercadopago/collection.rb
+- lib/mercadopago/merchant_order.rb
 - lib/mercadopago/request.rb
 - lib/mercadopago/version.rb
 - mercadopago.gemspec
 - test/test_mercado_pago.rb
 homepage: https://github.com/kauplus/mercadopago
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []