spree_paypal_express_mutalis 2.0.4

data/app/models/spree/gateway/pay_pal_express.rb

@@ -0,0 +1,100 @@
+require 'paypal-sdk-merchant'
+module Spree
+  class Gateway::PayPalExpress < Gateway
+    preference :login, :string
+    preference :password, :string
+    preference :signature, :string
+    preference :server, :string, default: 'sandbox'
+
+    def supports?(source)
+      true
+    end
+
+    def provider_class
+      ::PayPal::SDK::Merchant::API
+    end
+
+    def provider
+      ::PayPal::SDK.configure(
+        :mode      => preferred_server.present? ? preferred_server : "sandbox",
+        :username  => preferred_login,
+        :password  => preferred_password,
+        :signature => preferred_signature)
+      provider_class.new
+    end
+
+    def auto_capture?
+      true
+    end
+
+    def method_type
+      'paypal'
+    end
+
+    def purchase(amount, express_checkout, gateway_options={})
+      pp_request = provider.build_do_express_checkout_payment({
+        :DoExpressCheckoutPaymentRequestDetails => {
+          :PaymentAction => "Sale",
+          :Token => express_checkout.token,
+          :PayerID => express_checkout.payer_id,
+          :PaymentDetails => [{
+            :OrderTotal => {
+              :currencyID => Spree::Config[:currency],
+              # gsub is here because PayPal fails to acknowledge 
+              # that some people like their currencies written as:
+              # 21,99
+              # As opposed to:
+              # 21.99
+              # The international payments company fails to handle
+              # international payment amounts. SMH.
+              :value => ::Money.new(amount, Spree::Config[:currency]).to_s.gsub(',', '.') }
+          }]
+        }
+      })
+
+      pp_response = provider.do_express_checkout_payment(pp_request)
+      if pp_response.success?
+        # We need to store the transaction id for the future.
+        # This is mainly so we can use it later on to refund the payment if the user wishes.
+        transaction_id = pp_response.do_express_checkout_payment_response_details.payment_info.first.transaction_id
+        express_checkout.update_column(:transaction_id, transaction_id)
+        # This is rather hackish, required for payment/processing handle_response code.
+        Class.new do
+          def success?; true; end
+          def authorization; nil; end
+        end.new
+      else
+        class << pp_response
+          def to_s
+            errors.map(&:long_message).join(" ")
+          end
+        end
+        pp_response
+      end
+    end
+
+    def refund(payment, amount)
+      refund_type = payment.amount == amount.to_f ? "Full" : "Partial"
+      refund_transaction = provider.build_refund_transaction({
+        :TransactionID => payment.source.transaction_id,
+        :RefundType => refund_type,
+        :Amount => {
+          :currencyID => payment.currency,
+          :value => amount },
+        :RefundSource => "any" })
+      refund_transaction_response = provider.refund_transaction(refund_transaction)
+      if refund_transaction_response.success?
+        payment.source.update_attributes({
+          :refunded_at => Time.now,
+          :refund_transaction_id => refund_transaction_response.RefundTransactionID,
+          :state => "refunded",
+          :refund_type => refund_type
+        } )
+      end
+      refund_transaction_response
+    end
+  end
+end
+
+#   payment.state = 'completed'
+#   current_order.state = 'complete'

data/app/models/spree/paypal_express_checkout.rb

@@ -0,0 +1,4 @@
+module Spree
+  class PaypalExpressCheckout < ActiveRecord::Base
+  end
+end

data/app/views/spree/admin/payments/_paypal_complete.html.erb

@@ -0,0 +1,20 @@
+<%= form_tag paypal_refund_admin_order_payment_path(@order, @payment) do %>
+  <div class="label-block left five columns alpha">
+    <div>
+      <fieldset data-hook="admin_variant_new_form">
+        <legend><%= Spree.t('refund', :scope => :paypal) %></legend>
+        <div class='field'>
+          <%= label_tag 'refund_amount', Spree.t(:refund_amount, :scope => 'paypal') %>
+          <small><em><%= Spree.t(:original_amount, :scope => 'paypal', :amount => @payment.display_amount) %></em></small><br>
+          <% symbol = ::Money.new(1, Spree::Config[:currency]).symbol %>
+          <% if Spree::Config[:currency_symbol_position] == "before" %>
+            <%= symbol %><%= text_field_tag 'refund_amount', @payment.amount %>
+          <% else %>
+            <%= text_field_tag 'refund_amount', @payment.amount %><%= symbol %>
+          <% end %>
+        </div>
+        <%= button Spree.t(:refund, :scope => 'paypal'), 'icon-dollar' %>
+      </fieldset>
+    </div>
+  </div>
+<% end %>

data/app/views/spree/admin/payments/paypal_refund.html.erb

@@ -0,0 +1,31 @@
+<%= render :partial => 'spree/admin/shared/order_tabs', :locals => { :current => 'Payments' } %>
+
+<% content_for :page_title do %>
+  <i class="icon-arrow-right"></i>
+  <%= link_to Spree.t(:payments), admin_order_payments_path(@order) %>
+  <i class="icon-arrow-right"></i>
+  <%= payment_method_name(@payment) %>
+  <i class="icon-arrow-right"></i>
+  <%= Spree.t('refund', :scope => :paypal) %>
+<% end %>
+
+<%= form_tag paypal_refund_admin_order_payment_path(@order, @payment) do %>
+  <div class="label-block left five columns alpha">
+    <div>
+      <fieldset data-hook="admin_variant_new_form">
+        <legend><%= Spree.t('refund', :scope => :paypal) %></legend>
+        <div class='field'>
+          <%= label_tag 'refund_amount', Spree.t(:refund_amount, :scope => 'paypal') %>
+          <small><em><%= Spree.t(:original_amount, :scope => 'paypal', :amount => @payment.display_amount) %></em></small><br>
+          <% symbol = ::Money.new(1, Spree::Config[:currency]).symbol %>
+          <% if Spree::Config[:currency_symbol_position] == "before" %>
+            <%= symbol %><%= text_field_tag 'refund_amount', @payment.amount %>
+          <% else %>
+            <%= text_field_tag 'refund_amount', @payment.amount %><%= symbol %>
+          <% end %>
+        </div>
+        <%= button Spree.t(:refund, :scope => 'paypal'), 'icon-dollar' %>
+      </fieldset>
+    </div>
+  </div>
+<% end %>

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

@@ -0,0 +1,6 @@
+<div id='paypal-warning' style="display:none">
+  <strong>You cannot charge PayPal accounts through the admin backend at this time.</strong>
+</div>
+<script>
+  SpreePaypalExpress.paymentMethodID = "<%= payment_method.id %>"  
+</script>

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

@@ -0,0 +1,35 @@
+<fieldset data-hook="paypal">
+  <legend align="center"><%= Spree.t(:transaction, :scope => :paypal) %></legend>
+
+  <div class="row">
+    <div class="alpha six columns">
+      <dl>
+        <dt><%= Spree.t(:payer_id, :scope => :paypal) %>:</dt>
+        <dd><%= payment.source.payer_id %></dd>
+
+        <dt><%= Spree.t(:token, :scope => :paypal) %>:</dt>
+        <dd><%= payment.source.token %></dd>
+
+        <dt><%= Spree.t(:transaction_id) %>:</dt>
+        <dd><%= payment.source.transaction_id %></dd>
+      </dl>
+    </div>
+
+    <% if payment.source.state != 'refunded' %>
+      <%= button_link_to Spree.t('actions.refund', :scope => :paypal), spree.paypal_refund_admin_order_payment_path(@order, payment), :icon => 'icon-dollar' %>
+    <% else %>
+      <div class="alpha six columns">
+        <dl>
+          <dt><%= Spree.t(:state, :scope => :paypal) %>:</dt>
+          <dd><%= payment.source.state.titleize %></dd>
+
+          <dt><%= Spree.t(:refunded_at, :scope => :paypal) %>:</dt>
+          <dd><%= pretty_time(payment.source.refunded_at) %></dd>
+
+          <dt><%= Spree.t(:refund_transaction_id, :scope => :paypal) %>:</dt>
+          <dd><%= payment.source.refund_transaction_id %></dd>
+        </dl>
+      </div>
+    <% end %>
+  </div>
+</fieldset>

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

@@ -0,0 +1,6 @@
+
+<%= link_to(image_tag("https://www.paypal.com/en_US/i/btn/btn_xpressCheckout.gif"), paypal_express_url(:payment_method_id => payment_method.id), :method => :post, :id => "paypal_button") %>
+
+<script>
+  SpreePaypalExpress.paymentMethodID = "<%= payment_method.id %>"  
+ </script>

data/config/locales/en.yml

@@ -0,0 +1,16 @@
+---
+en:
+  spree:
+    paypal:
+      already_refunded: "This payment has been refunded and no further action can be taken on it."
+      transaction: "PayPal Transaction"
+      payer_id: "Payer ID"
+      transaction_id: "Transaction ID"
+      token: "Token"
+      refund: "Refund"
+      refund_amount: "Amount"
+      original_amount: "Original amount: %{amount}"
+      refund_successful: "PayPal refund successful"
+      refund_unsuccessful: "PayPal refund unsuccessful"
+      actions:
+        refund: "Refund"

data/config/routes.rb

@@ -0,0 +1,18 @@
+Spree::Core::Engine.routes.draw do
+  post '/paypal', :to => "paypal#express", :as => :paypal_express
+  get '/paypal/confirm', :to => "paypal#confirm", :as => :confirm_paypal
+  get '/paypal/cancel', :to => "paypal#cancel", :as => :cancel_paypal
+  get '/paypal/notify', :to => "paypal#notify", :as => :notify_paypal
+
+  namespace :admin do
+    # Using :only here so it doesn't redraw those routes
+    resources :orders, :only => [] do
+      resources :payments, :only => [] do
+        member do
+          get 'paypal_refund'
+          post 'paypal_refund'
+        end
+      end
+    end
+  end
+end

data/db/migrate/20130723042610_create_spree_paypal_express_checkouts.rb

@@ -0,0 +1,8 @@
+class CreateSpreePaypalExpressCheckouts < ActiveRecord::Migration
+  def change
+    create_table :spree_paypal_express_checkouts do |t|
+      t.string :token
+      t.string :payer_id
+    end
+  end
+end

data/db/migrate/20130808030836_add_transaction_id_to_spree_paypal_express_checkouts.rb

@@ -0,0 +1,6 @@
+class AddTransactionIdToSpreePaypalExpressCheckouts < ActiveRecord::Migration
+  def change
+    add_column :spree_paypal_express_checkouts, :transaction_id, :string
+    add_index :spree_paypal_express_checkouts, :transaction_id
+  end
+end

data/db/migrate/20130809013846_add_state_to_spree_paypal_express_checkouts.rb

@@ -0,0 +1,5 @@
+class AddStateToSpreePaypalExpressCheckouts < ActiveRecord::Migration
+  def change
+    add_column :spree_paypal_express_checkouts, :state, :string, :default => "complete"
+  end
+end

data/db/migrate/20130809014319_add_refunded_fields_to_spree_paypal_express_checkouts.rb

@@ -0,0 +1,8 @@
+class AddRefundedFieldsToSpreePaypalExpressCheckouts < ActiveRecord::Migration
+  def change
+    add_column :spree_paypal_express_checkouts, :refund_transaction_id, :string
+    add_column :spree_paypal_express_checkouts, :refunded_at, :datetime
+    add_column :spree_paypal_express_checkouts, :refund_type, :string
+    add_column :spree_paypal_express_checkouts, :created_at, :datetime
+  end
+end

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

@@ -0,0 +1,31 @@
+module SpreePaypalExpress
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+      class_option :auto_run_migrations, :type => :boolean, :default => false
+
+      def add_javascripts
+        append_file 'app/assets/javascripts/store/all.js', "//= require store/spree_paypal_express\n"
+        append_file 'app/assets/javascripts/admin/all.js', "//= require admin/spree_paypal_express\n"
+      end
+
+      def add_stylesheets
+        inject_into_file 'app/assets/stylesheets/store/all.css', " *= require store/spree_paypal_express\n", :before => /\*\//, :verbose => true
+        inject_into_file 'app/assets/stylesheets/admin/all.css', " *= require admin/spree_paypal_express\n", :before => /\*\//, :verbose => true
+      end
+
+      def add_migrations
+        run 'bundle exec rake railties:install:migrations FROM=spree_paypal_express'
+      end
+
+      def run_migrations
+        run_migrations = options[:auto_run_migrations] || ['', 'y', 'Y'].include?(ask 'Would you like to run the migrations now? [Y/n]')
+        if run_migrations
+          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_paypal_express.rb

@@ -0,0 +1,3 @@
+require 'spree_core'
+require 'spree_paypal_express/version'
+require 'spree_paypal_express/engine'

data/lib/spree_paypal_express/engine.rb

@@ -0,0 +1,26 @@
+module SpreePaypalExpress
+  class Engine < Rails::Engine
+    require 'spree/core'
+    isolate_namespace Spree
+    engine_name 'spree_paypal_express'
+
+    config.autoload_paths += %W(#{config.root}/lib)
+
+    # use rspec for tests
+    config.generators do |g|
+      g.test_framework :rspec
+    end
+
+    def self.activate
+      Dir.glob(File.join(File.dirname(__FILE__), '../../app/**/*_decorator*.rb')) do |c|
+        Rails.configuration.cache_classes ? require(c) : load(c)
+      end
+    end
+
+    config.to_prepare &method(:activate).to_proc
+
+    initializer "spree.paypal_express.payment_methods", :after => "spree.register.payment_methods" do |app|
+      app.config.spree.payment_methods << Spree::Gateway::PayPalExpress
+    end
+  end
+end

data/lib/spree_paypal_express/factories.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  # Define your Spree extensions Factories within this file to enable applications, and other extensions to use and override them.
+  #
+  # Example adding this to your spec_helper will load these Factories for use:
+  # require 'spree_paypal_express/factories'
+end

data/lib/spree_paypal_express/version.rb

@@ -0,0 +1,3 @@
+module SpreePayPalExpress
+  VERSION = '2.0.4'
+end

data/script/rails

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_paypal_express/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/spec/features/paypal_spec.rb

@@ -0,0 +1,244 @@
+require 'spec_helper'
+
+describe "PayPal", :js => true do
+  let!(:product) { FactoryGirl.create(:product, :name => 'iPad') }
+  before do
+    @gateway = Spree::Gateway::PayPalExpress.create!({
+      :preferred_login => "paypal_api1.ryanbigg.com",
+      :preferred_password => "1373587879",
+      :preferred_signature => "ACOYQHq-aXKftiD4jURhihawsVSsAsaMr4qH4Tz4K17mJoa3K4M0Dvop",
+      :name => "PayPal",
+      :active => true,
+      :environment => Rails.env
+    })
+    FactoryGirl.create(:shipping_method)
+  end
+  def fill_in_billing
+    within("#billing") do
+      fill_in "First Name", :with => "Test"
+      fill_in "Last Name", :with => "User"
+      fill_in "Street Address", :with => "1 User Lane"
+      # City, State and ZIP must all match for PayPal to be happy
+      fill_in "City", :with => "Adamsville"
+      select "United States of America", :from => "order_bill_address_attributes_country_id"
+      select "Alabama", :from => "order_bill_address_attributes_state_id"
+      fill_in "Zip", :with => "35005"
+      fill_in "Phone", :with => "555-AME-RICA"
+    end
+  end
+
+  def switch_to_paypal_login
+    # If you go through a payment once in the sandbox, it remembers your preferred setting.
+    # It defaults to the *wrong* setting for the first time, so we need to have this method.
+    unless page.has_selector?("#login_email")
+      find("#loadLogin").click
+    end
+  end
+  it "pays for an order successfully" do
+    visit spree.root_path
+    click_link 'iPad'
+    click_button 'Add To Cart'
+    click_button 'Checkout'
+    within("#guest_checkout") do
+      fill_in "Email", :with => "test@example.com"
+      click_button 'Continue'
+    end
+    fill_in_billing
+    click_button "Save and Continue"
+    # Delivery step doesn't require any action
+    click_button "Save and Continue"
+    find("#paypal_button").click
+    switch_to_paypal_login
+    fill_in "login_email", :with => "pp@spreecommerce.com"
+    fill_in "login_password", :with => "thequickbrownfox"
+    click_button "Log In"
+    find("#continue_abovefold").click   # Because there's TWO continue buttons.
+    page.should have_content("Your order has been processed successfully")
+
+    Spree::Payment.last.source.transaction_id.should_not be_blank
+  end
+
+  it "includes adjustments in PayPal summary" do
+    visit spree.root_path
+    click_link 'iPad'
+    click_button 'Add To Cart'
+    # TODO: Is there a better way to find this current order?
+    order = Spree::Order.last
+    order.adjustments.create!(:amount => -5, :label => "$5 off")
+    order.adjustments.create!(:amount => 10, :label => "$10 on")
+    visit '/cart'
+    within("#cart_adjustments") do
+      page.should have_content("$5 off")
+      page.should have_content("$10 on")
+    end
+    click_button 'Checkout'
+    within("#guest_checkout") do
+      fill_in "Email", :with => "test@example.com"
+      click_button 'Continue'
+    end
+    fill_in_billing
+    click_button "Save and Continue"
+    # Delivery step doesn't require any action
+    click_button "Save and Continue"
+    find("#paypal_button").click
+    within("#miniCart") do
+      page.should have_content("$5 off")
+      page.should have_content("$10 on")
+    end
+  end
+
+  # Regression test for #10
+  context "will skip $0 items" do
+    let!(:product2) { FactoryGirl.create(:product, :name => 'iPod') }
+
+    specify do
+      visit spree.root_path
+      click_link 'iPad'
+      click_button 'Add To Cart'
+
+      visit spree.root_path
+      click_link 'iPod'
+      click_button 'Add To Cart'
+
+      # TODO: Is there a better way to find this current order?
+      order = Spree::Order.last
+      order.line_items.last.update_attribute(:price, 0)
+      click_button 'Checkout'
+      within("#guest_checkout") do
+        fill_in "Email", :with => "test@example.com"
+        click_button 'Continue'
+      end
+      fill_in_billing
+      click_button "Save and Continue"
+      # Delivery step doesn't require any action
+      click_button "Save and Continue"
+      find("#paypal_button").click
+      within("#miniCart") do
+        page.should have_content('iPad')
+        page.should_not have_content('iPod')
+      end
+    end
+  end
+
+  context "can process an order with $0 item total" do
+    before do
+      # If we didn't do this then the order would be free and skip payment altogether
+      calculator = Spree::ShippingMethod.first.calculator
+      calculator.preferred_amount = 10
+      calculator.save
+    end
+
+    specify do
+      visit spree.root_path
+      click_link 'iPad'
+      click_button 'Add To Cart'
+      # TODO: Is there a better way to find this current order?
+      order = Spree::Order.last
+      order.adjustments.create!(:amount => -order.line_items.last.price, :label => "FREE iPad ZOMG!")
+      click_button 'Checkout'
+      within("#guest_checkout") do
+        fill_in "Email", :with => "test@example.com"
+        click_button 'Continue'
+      end
+      fill_in_billing
+      click_button "Save and Continue"
+      # Delivery step doesn't require any action
+      click_button "Save and Continue"
+      find("#paypal_button").click
+      within("#miniCart") do
+        page.should have_content('Current purchase')
+      end
+    end
+  end
+
+  context "cannot process a payment with invalid gateway details" do
+    before do
+      @gateway.preferred_login = nil
+      @gateway.save
+    end
+
+    specify do
+      visit spree.root_path
+      click_link 'iPad'
+      click_button 'Add To Cart'
+      click_button 'Checkout'
+      within("#guest_checkout") do
+        fill_in "Email", :with => "test@example.com"
+        click_button 'Continue'
+      end
+      fill_in_billing
+      click_button "Save and Continue"
+      # Delivery step doesn't require any action
+      click_button "Save and Continue"
+      find("#paypal_button").click
+      page.should have_content("PayPal failed. Security header is not valid")
+    end
+  end
+
+  context "as an admin" do
+    stub_authorization!
+
+    context "refunding payments" do
+      before do
+        visit spree.root_path
+        click_link 'iPad'
+        click_button 'Add To Cart'
+        click_button 'Checkout'
+        within("#guest_checkout") do
+          fill_in "Email", :with => "test@example.com"
+          click_button 'Continue'
+        end
+        fill_in_billing
+        click_button "Save and Continue"
+        # Delivery step doesn't require any action
+        click_button "Save and Continue"
+        find("#paypal_button").click
+        switch_to_paypal_login
+        fill_in "login_email", :with => "pp@spreecommerce.com"
+        fill_in "login_password", :with => "thequickbrownfox"
+        click_button "Log In"
+        find("#continue_abovefold").click   # Because there's TWO continue buttons.
+        page.should have_content("Your order has been processed successfully")
+
+        visit '/admin'
+        click_link Spree::Order.last.number
+        click_link "Payments"
+        click_link "PayPal"
+        click_link "Refund"
+      end
+
+      it "can refund payments fully" do
+        click_button "Refund"
+        page.should have_content("PayPal refund successful")
+
+        payment = Spree::Payment.last
+        source = payment.source
+        source.refund_transaction_id.should_not be_blank
+        source.refunded_at.should_not be_blank
+        source.state.should eql("refunded")
+        source.refund_type.should eql("Full")
+      end
+
+      it "can refund payments partially" do
+        payment = Spree::Payment.last
+        # Take a dollar off, which should cause refund type to be...
+        fill_in "Amount", :with => payment.amount - 1
+        click_button "Refund"
+        page.should have_content("PayPal refund successful")
+
+        source = payment.source
+        source.refund_transaction_id.should_not be_blank
+        source.refunded_at.should_not be_blank
+        source.state.should eql("refunded")
+        # ... a partial refund
+        source.refund_type.should eql("Partial")
+      end
+
+      it "errors when given an invalid refund amount" do
+        fill_in "Amount", :with => "lol"
+        click_button "Refund"
+        page.should have_content("PayPal refund unsuccessful (The partial refund amount is not valid)")
+      end
+    end
+  end
+end