spree_mercado_pago 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2eb53fdc0027372aa67444c564b5ccc6372d8018
+  data.tar.gz: decbb3c087eb1ef31e0553c1eaa24c7a2ade4ffb
+SHA512:
+  metadata.gz: 731070b18f180e4b058297b0542d235a0772432f71b197e7c201e6cd61b2b5ff67d6300b7688233e5b8c11390f5bc95f964c75e8786465e543ab6cfbe5ee8229
+  data.tar.gz: 88d6e6f3e9b961dc36a551c1870253128a18c6ab81c98aef683de4855be3c4958a5b698f4725372aae0519f3d93ebc20e6e09fe0f0cd36bb9b301ad42dafee83

data/app/assets/javascripts/spree/admin/spree_mercado_pago_payment_method.js

@@ -0,0 +1 @@
+//= require admin/spree_core

data/app/assets/javascripts/spree/frontend/spree_mercado_pago_payment_method.js

@@ -0,0 +1,25 @@
+//= require spree/frontend
+
+MercadoPago = {
+  hidePaymentSaveAndContinueButton: function(paymentMethod) {
+    if (MercadoPago.paymentMethodID && paymentMethod.val() == MercadoPago.paymentMethodID) {
+      $('.continue').hide();
+      $('[data-hook=coupon_code]').hide();
+    } else {
+      $('.continue').show();
+      $('[data-hook=coupon_code]').show();
+    }
+  }
+};
+
+$(document).ready(function() {
+  checkedPaymentMethod = $('div[data-hook="checkout_payment_step"] input[type="radio"]:checked');
+  MercadoPago.hidePaymentSaveAndContinueButton(checkedPaymentMethod);
+  paymentMethods = $('div[data-hook="checkout_payment_step"] input[type="radio"]').click(function (e) {
+    MercadoPago.hidePaymentSaveAndContinueButton($(e.target));
+  });
+
+  $('button.mercado_pago_button').click(function(event){
+    $(event.target).prop("disabled",true);
+  });
+});

data/app/assets/stylesheets/admin/spree_mercado_pago_payment_method.css

@@ -0,0 +1,3 @@
+/*
+ *= require admin/spree_core
+*/

data/app/assets/stylesheets/store/spree_mercado_pago_payment_method.css

@@ -0,0 +1,3 @@
+/*
+ *= require store/spree_core
+*/

data/app/controllers/spree/mercado_pago_controller.rb

@@ -0,0 +1,69 @@
+module Spree
+  class MercadoPagoController < StoreController
+    protect_from_forgery except: :ipn
+    skip_before_filter :set_current_order, only: :ipn
+
+    def checkout
+      current_order.state_name == :payment || raise(ActiveRecord::RecordNotFound)
+      payment_method = PaymentMethod::MercadoPago.find(params[:payment_method_id])
+      payment = current_order.payments.
+        create!({amount: current_order.total, payment_method: payment_method})
+      payment.started_processing!
+
+      preferences = ::MercadoPago::OrderPreferencesBuilder.
+        new(current_order, payment, callback_urls).
+        preferences_hash
+
+      provider = payment_method.provider
+      provider.create_preferences(preferences)
+
+      redirect_to provider.redirect_url
+    end
+
+    # Success/pending callbacks are currently aliases, this may change
+    # if required.
+    def success
+      payment.pend!
+      payment.order.next
+      flash.notice = Spree.t(:order_processed_successfully)
+      flash['order_completed'] = true
+      redirect_to spree.order_path(payment.order)
+    end
+
+    def failure
+      payment.failure!
+      flash.notice = Spree.t(:payment_processing_failed)
+      flash['order_completed'] = true
+      redirect_to spree.checkout_state_path(state: :payment)
+    end
+
+    def ipn
+      notification = MercadoPago::Notification.
+        new(operation_id: params[:id], topic: params[:topic])
+
+      if notification.save
+        MercadoPago::HandleReceivedNotification.new(notification).process!
+        status = :ok
+      else
+        status = :bad_request
+      end
+
+      render nothing: true, status: status
+    end
+
+    private
+
+    def payment
+      @payment ||= Spree::Payment.where(identifier: params[:external_reference]).
+        first
+    end
+
+    def callback_urls
+      @callback_urls ||= {
+        success: mercado_pago_success_url,
+        pending: mercado_pago_success_url,
+        failure: mercado_pago_failure_url
+      }
+    end
+  end
+end

data/app/models/mercado_pago/client/api.rb

@@ -0,0 +1,43 @@
+require 'json'
+
+class MercadoPago::Client
+  module API
+    def redirect_url
+      point_key = sandbox ? 'sandbox_init_point' : 'init_point'
+      @preferences_response[point_key]
+    end
+
+    private
+
+    def notifications_url(operation_id)
+      sandbox_part = sandbox ? 'sandbox/' : ''
+      "https://api.mercadolibre.com/#{sandbox_part}collections/notifications/#{operation_id}"
+    end
+
+    def search_url
+      sandbox_part = sandbox ? 'sandbox/' : ''
+      "https://api.mercadolibre.com/#{sandbox_part}collections/search"
+    end
+
+    def create_url(url, params={})
+      uri = URI(url)
+      uri.query = URI.encode_www_form(params)
+      uri.to_s
+    end
+
+    def preferences_url(token)
+      create_url('https://api.mercadolibre.com/checkout/preferences', access_token: token)
+    end
+
+    def sandbox
+      @api_options[:sandbox]
+    end
+
+    def get(url, request_options={}, options={})
+      response = RestClient.get(url, request_options)
+      JSON.parse(response)
+    rescue => e
+      raise e unless options[:quiet]
+    end
+  end
+end

data/app/models/mercado_pago/client/authentication.rb

@@ -0,0 +1,36 @@
+require 'json'
+
+class MercadoPago::Client
+  module Authentication
+    def authenticate
+      response = send_authentication_request
+      @auth_response = JSON.parse(response)
+    rescue RestClient::Exception => e
+      @errors << I18n.t(:authentication_error, scope: :mercado_pago)
+      raise RuntimeError.new e.message
+    end
+
+    private
+
+    def send_authentication_request
+      RestClient.post(
+        'https://api.mercadolibre.com/oauth/token',
+        {:grant_type => 'client_credentials', :client_id => client_id, :client_secret => client_secret},
+        :content_type => 'application/x-www-form-urlencoded', :accept => 'application/json'
+      )
+    end
+
+    def client_id
+      @payment_method.preferred_client_id
+    end
+
+    def client_secret
+      @payment_method.preferred_client_secret
+    end
+
+    def access_token
+      authenticate unless @auth_response
+      @auth_response['access_token']
+    end
+  end
+end

data/app/models/mercado_pago/client/preferences.rb

@@ -0,0 +1,20 @@
+require 'json'
+
+class MercadoPago::Client
+  module Preferences
+    def create_preferences(preferences)
+      response = send_preferences_request(preferences)
+      @preferences_response = JSON.parse(response)
+    rescue RestClient::Exception => e
+      @errors << I18n.t(:authentication_error, scope: :mercado_pago)
+      raise RuntimeError.new(e.message)
+    end
+
+    private
+
+    def send_preferences_request(preferences)
+      RestClient.post(preferences_url(access_token), preferences.to_json,
+                      :content_type => 'application/json', :accept => 'application/json')
+    end
+  end
+end

data/app/models/mercado_pago/client.rb

@@ -0,0 +1,63 @@
+require 'rest_client'
+require 'mercado_pago/client/authentication'
+require 'mercado_pago/client/preferences'
+require 'mercado_pago/client/api'
+
+module MercadoPago
+  class Client
+    # These three includes are because of the user of line_item_description from
+    # ProductsHelper
+    include Authentication
+    include Preferences
+    include API
+
+    attr_reader :errors
+    attr_reader :auth_response
+    attr_reader :preferences_response
+
+    def initialize(payment_method, options={})
+      @payment_method = payment_method
+      @api_options    = options.clone
+      @errors         = []
+    end
+
+    def get_operation_info(operation_id)
+      url = create_url(notifications_url(operation_id), access_token: access_token)
+      options = {content_type: 'application/x-www-form-urlencoded', accept: 'application/json'}
+      get(url, options, quiet: true)
+    end
+
+
+    # def get_external_reference(operation_id)
+    #   response = send_notification_request(operation_id)
+    #   if response
+    #     response['collection']['external_reference']
+    #   end
+    # end
+
+    def get_payment_status(external_reference)
+      response = send_search_request({external_reference: external_reference, access_token: access_token})
+
+      if response['results'].empty?
+        "pending"
+      else
+        response['results'][0]['collection']['status']
+      end
+    end
+
+    private
+
+    def log_error(msg, response, request, result)
+      Rails.logger.info msg
+      Rails.logger.info "response: #{response}."
+      Rails.logger.info "request args: #{request.args}."
+      Rails.logger.info "result #{result}."
+    end
+
+    def send_search_request(params, options={})
+      url = create_url(search_url, params)
+      options = {content_type: 'application/x-www-form-urlencoded', accept: 'application/json'}
+      get(url, options)
+    end
+  end
+end

data/app/models/mercado_pago/notification.rb

@@ -0,0 +1,8 @@
+module MercadoPago
+  class Notification < ActiveRecord::Base
+    self.table_name = "mercado_pago_notifications"
+    
+    validates :topic, presence: true, inclusion: {in: %w(payment preapproval authorized_payment merchant_order) }
+    validates :operation_id, presence: true
+  end
+end

data/app/models/mercado_pago/order_preferences_builder.rb

@@ -0,0 +1,68 @@
+module MercadoPago
+  class OrderPreferencesBuilder
+    include ActionView::Helpers::TextHelper
+    include ActionView::Helpers::SanitizeHelper
+    include Spree::ProductsHelper
+
+    def initialize(order, payment, callback_urls, payer_data = nil)
+      @order         = order
+      @payment       = payment
+      @callback_urls = callback_urls
+      @payer_data    = payer_data
+    end
+
+    def preferences_hash
+      {
+        external_reference: @payment.identifier,
+        back_urls: @callback_urls,
+        payer: @payer_data,
+        items: generate_items
+      }
+    end
+
+    private
+
+    def generate_items
+      items = []
+
+      items += generate_items_from_line_items
+      items += generate_items_from_adjustments
+      items += generate_items_from_shipments
+
+      items
+    end
+
+    def generate_items_from_shipments
+      @order.shipments.collect do |shipment|
+        {
+          :title => shipment.shipping_method.name,
+          :unit_price => shipment.cost.to_f,
+          :quantity => 1,
+          :currency_id => 'ARS'
+        }
+      end
+    end
+
+    def generate_items_from_line_items
+      @order.line_items.collect do |line_item|
+        {
+          :title => line_item_description_text(line_item.variant.product.name),
+          :unit_price => line_item.price.to_f,
+          :quantity => line_item.quantity,
+          :currency_id => 'ARS'
+        }
+      end
+    end
+
+    def generate_items_from_adjustments
+      @order.adjustments.eligible.collect do |adjustment|
+        {
+          title: line_item_description_text(adjustment.label),
+          unit_price: adjustment.amount.to_f,
+          quantity: 1,
+          currency_id: "ARS"
+        }
+      end
+    end
+  end
+end

data/app/models/spree/payment_method/mercado_pago.rb

@@ -0,0 +1,46 @@
+module Spree
+  class PaymentMethod::MercadoPago < PaymentMethod
+    preference :client_id,     :integer
+    preference :client_secret, :string
+    preference :sandbox, :boolean, default: true
+
+    def payment_profiles_supported?
+      false
+    end
+
+    def provider_class
+      ::MercadoPago::Client
+    end
+
+    def provider(additional_options = {})
+      @provider ||= begin
+                      options = { sandbox: preferred_sandbox }
+                      client = provider_class.new(self, options.merge(additional_options))
+                      client.authenticate
+                      client
+                    end
+    end
+
+    def source_required?
+      false
+    end
+
+    def auto_capture?
+      false
+    end
+
+    ## Admin options
+
+    def can_void?(payment)
+      payment.state != 'void'
+    end
+
+    def actions
+      %w{void}
+    end
+
+    def void(*args)
+      ActiveMerchant::Billing::Response.new(true, "", {}, {})
+    end
+  end
+end

data/app/services/mercado_pago/handle_received_notification.rb

@@ -0,0 +1,18 @@
+module MercadoPago
+  class HandleReceivedNotification
+    def initialize(notification)
+      @notification = notification
+    end
+
+    # The purpose of this method is to enable async/sync processing
+    # of Mercado Pago IPNs. For simplicity processing is synchronous but
+    # if you would like to enqueue the processing via Resque/Ost/etc you
+    # will be able to do it.
+    def process!
+      # Sync
+      ProcessNotification.new(@notification).process!
+      # Async Will be configurable via block for example:
+      # Resque.enqueue(ProcessNotificationWorker, {id: @notification.id})
+    end
+  end
+end

data/app/services/mercado_pago/process_notification.rb

@@ -0,0 +1,54 @@
+# Process notification:
+# ---------------------
+# Fetch collection information
+# Find payment by external reference
+# If found
+#   Update payment status
+#   Notify user
+# If not found
+#   Ignore notification (maybe payment from outside Spree)
+module MercadoPago
+  class ProcessNotification
+    # Equivalent payment states
+    # MP state => Spree state
+    # =======================
+    #
+    # approved     => complete
+    # pending      => pend
+    # in_process   => pend
+    # rejected     => failed
+    # refunded     => void
+    # cancelled    => void
+    # in_mediation => pend
+    # charged_back => void
+    STATES = {
+      complete: %w(approved),
+      failure: %w(rejected),
+      void:    %w(refunded cancelled charged_back)
+    }
+
+    attr_reader :notification
+
+    def initialize(notification)
+      @notification = notification
+    end
+
+    def process!
+      client = ::Spree::PaymentMethod::MercadoPago.provider
+      op_info = client.get_operation_info(notification.operation_id)["collection"]
+
+      if payment = Spree::Payment.where(identifier: op_info["external_reference"]).first
+        if STATES[:complete].include?(op_info["status"])
+          payment.complete
+        elsif STATES[:failure].include?(op_info["status"])
+          payment.failure
+        elsif STATES[:void].include?(op_info["status"])
+          payment.void
+        end
+
+        # When Spree issue #5246 is fixed we can remove this line
+        payment.order.updater.update
+      end
+    end
+  end
+end

data/app/views/spree/admin/payments/source_forms/_mercadopago.html.erb

@@ -0,0 +1 @@
+<!-- Source form -->

data/app/views/spree/admin/payments/source_views/_mercadopago.html.erb

@@ -0,0 +1 @@
+<!-- Source view -->

data/app/views/spree/checkout/payment/_mercadopago.html.erb

@@ -0,0 +1,15 @@
+<script>
+  MercadoPago.paymentMethodID = "<%= payment_method.id %>";
+</script>
+
+<div class="row">
+  <div class="twelve rows alpha omega">
+    <img src="http://imgmp.mlstatic.com/org-img/banners/ar/medios/575X40.jpg" title="MercadoPago - Medios de pago" alt="MercadoPago - Medios de pago" width="575" height="40"/>
+  </div>
+</div>
+
+<div class="row">
+  <div class="twelve rows alpha omega">
+    <%= link_to I18n.t(:make_payment, scope: :mercado_pago), mercado_pago_checkout_path(payment_method_id: payment_method.id), method: :post, class: "button primary" %>
+  </div>
+</div>

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  mercado_pago:
+    make_payment: "Pay with Mercado Pago"
+    authentication_error: "It was not possible to authenticate with Mercado Pago"

data/config/locales/es.yml

@@ -0,0 +1,4 @@
+es:
+  mercado_pago:
+    make_payment: "Realizar pago en Mercado Pago"
+    authentication_error: "Hubo un error al realizar la autenticación con Mercado Pago"

data/config/routes.rb

@@ -0,0 +1,6 @@
+Spree::Core::Engine.add_routes do
+  post '/mercado_pago/checkout', to: "mercado_pago#checkout", as: :mercado_pago_checkout
+  get  '/mercado_pago/success', to: "mercado_pago#success", as: :mercado_pago_success
+  get  '/mercado_pago/failure', to: "mercado_pago#failure", as: :mercado_pago_failure
+  post '/mercado_pago/ipn', to: "mercado_pago#ipn", as: :mercado_pago_ipn
+end

data/lib/generators/spree_mercado_pago_payment_method/install/install_generator.rb

@@ -0,0 +1,34 @@
+module SpreeMercadoPagoPaymentMethod
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      def add_javascripts
+        append_file 'vendor/assets/javascripts/spree/frontend/all.js', "//= require spree/frontend/spree_mercado_pago_payment_method\n"
+        append_file 'vendor/assets/javascripts/spree/backend/all.js', "//= require spree/backend/spree_mercado_pago_payment_method\n"
+      end
+
+      def add_stylesheets
+        frontend_css_file = "vendor/assets/stylesheets/spree/frontend/all.css"
+        backend_css_file = "vendor/assets/stylesheets/spree/backend/all.css"
+
+        if File.exist?(backend_css_file) && File.exist?(frontend_css_file)
+          inject_into_file frontend_css_file, " *= require spree/frontend/spree_mercado_pago_payment_method\n", :before => /\*\//, :verbose => true
+          inject_into_file backend_css_file, " *= require spree/backend/spree_mercado_pago_payment_method\n", :before => /\*\//, :verbose => true
+        end
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_mercado_pago_payment_method'
+      end
+
+      def run_migrations
+        res = ask 'Would you like to run the migrations now? [Y/n]'
+        if res == '' || res.downcase == 'y'
+          run 'bundle exec rake db:migrate'
+        else
+          puts 'Skipping rake db:migrate, don\'t forget to run it!'
+        end
+      end
+    end
+  end
+end

data/lib/spree_mercado_pago_payment_method/engine.rb

@@ -0,0 +1,22 @@
+require 'spree_core'
+
+module SpreeMercadoPagoPaymentMethod
+  class Engine < Rails::Engine
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), "../../app/**/*_decorator*.rb")) do |c|
+        Rails.application.config.cache_classes ? require(c) : load(c)
+      end
+
+      Dir.glob(File.join(File.dirname(__FILE__), "../../app/overrides/*.rb")) do |c|
+        Rails.application.config.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    initializer "spree_payment_network.register.payment_methods" do |app|
+      app.config.spree.payment_methods += [Spree::PaymentMethod::MercadoPago]
+    end
+
+    config.to_prepare &method(:activate).to_proc
+  end
+end

data/lib/spree_mercado_pago_payment_method.rb

@@ -0,0 +1,4 @@
+# -*- encoding : utf-8 -*-
+require 'spree_core'
+require 'spree_frontend'
+require 'spree_mercado_pago_payment_method/engine'

data/lib/tasks/mercado_user.rake

@@ -0,0 +1,5 @@
+namespace :mercado_pago do
+  desc "Creates test user using MP API"
+  task :test_user => :environment do
+  end
+end

data/spec/controllers/spree/mercado_pago_controller_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+module Spree
+  describe MercadoPagoController do
+    describe "#ipn" do
+      let(:operation_id) { "op123" }
+
+      describe "for valid notifications" do
+        let(:use_case) { double("use_case") }
+
+        it "handles notification and returns success" do
+          MercadoPago::HandleReceivedNotification.should_receive(:new).and_return(use_case)
+          use_case.should_receive(:process!)
+
+          spree_post :ipn, { id: operation_id, topic: "payment" }
+          response.should be_success
+
+          notification = ::MercadoPago::Notification.order(:created_at).last
+          notification.topic.should eq("payment")
+          notification.operation_id.should eq(operation_id)
+        end
+      end
+
+      describe "for invalid notification" do
+        it "responds with invalid request" do
+          spree_post :ipn, { id: operation_id, topic: "nonexistent_topic" }
+          response.should be_bad_request
+        end
+      end
+    end
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks