spree_paypal_express_mutalis 2.0.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MDE3OGU1MzJiZmIwZDQ5MmQzZmNiNDlhODVlM2YyZjQzMjNlMDAyNg==
+  data.tar.gz: !binary |-
+    YTA3MGM1N2YxNTEzMGYyNmY4MTI0ZGQ3OGNmMjg5MmJmNzU0NjcxNQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    YzJhMTlhMzQ2NTdkNTM0NTc4ZGQwOTI2NmI1OTI5ZjQ3Y2ZiOGQ2YjBhNmE0
+    YTcxMmI3MDY4YmIxMDhkYzlmZTBlZTcxNjFiM2Q2MGUyNTViZmEwMWQ0Yjhh
+    ODBkYzdiNWYxMGFhMzNhNWZhZWU5MzQ0ZjE1Nzc5ZWNlYWY4M2M=
+  data.tar.gz: !binary |-
+    MTIwMWE5YmFlMWU5YWI1MzlkNzgyMDUyMjAxY2JhY2YyZDI4MWQ3ZjY2ODI0
+    M2YxOWE2OWUxYmNhNjZhZGNhMGU0ZDQyMTg1YTk5NWQzZmZjZDhhMzJhY2Iy
+    OTA0OGU0NjAxZTM2OWI3Y2FlNWI5Y2RiYTc3ODUxMmM4MWFkNzI=

data/.gitignore

@@ -0,0 +1,10 @@
+\#*
+*~
+.#*
+.DS_Store
+coverage
+Gemfile.lock
+tmp
+pkg
+spec/dummy
+.rvmrc

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+before_script:
+  - sh -e /etc/init.d/xvfb start
+  - export DISPLAY=:99.0
+  - bundle exec rake test_app
+script:
+  - bundle exec rspec spec
+notifications:
+  email:
+    - ryan@spreecommerce.com
+rvm:
+  - 1.9.3
+  - 2.0.0
+branches:
+  only:
+    - master

data/CONTRIBUTING.md

@@ -0,0 +1,81 @@
+Spree Paypal Express is an open source project and we encourage contributions.  Please see the
+[contributors guidelines](http://spreecommerce.com/documentation/contributing_to_spree.html)
+before contributing.
+
+## Filing an issue
+
+When filing an issue on this extension, please first do these things:
+
+* Verify you can reproduce this issue in a brand new application.
+* Include the `httplog` in that application's Gemfile.
+* Run through the steps to reproduce the issue again.
+* Create a Gist which contains the complete output from the server during the course of these transactions.
+
+This information will help us replicate what's going wrong on the PayPal side of things.
+
+In the issue itself please provide:
+
+* A comprehensive list of steps to reproduce the issue.
+* What you're *expecting* to happen compared with what's *actually* happening.
+* The version of Spree *and* the version of Rails.
+* A list of all extensions.
+* Any relevant stack traces ("Full trace" preferred)
+* Your Gemfile
+
+In 99% of cases, this information is enough to determine the cause and solution
+to the problem that is being described.
+
+Please remember to format code using triple backticks (\`) so that it is neatly
+formatted when the issue is posted.
+
+Any issue that is open for 14 days without actionable information or activity
+will be marked as "stalled" and then closed. Stalled issues can be re-opened if
+the information requested is provided.
+
+## Pull requests
+
+We gladly accept pull requests to fix bugs and, in some circumstances, add new
+features to this extension.
+
+Here's a quick guide:
+
+1. Fork the repo.
+
+2. Run the tests. We only take pull requests with passing tests, and it's great
+to know that you have a clean slate:
+
+        $ bash build.sh
+
+3. Create new branch then make changes and add tests for your changes. Only
+refactoring and documentation changes require no new tests. If you are adding
+functionality or fixing a bug, we need tests!
+
+4. Push to your fork and submit a pull request. If the changes will apply cleanly
+to the latest stable branches and master branch, you will only need to submit one
+pull request.
+
+At this point you're waiting on us. We like to at least comment on, if not
+accept, pull requests within three business days (and, typically, one business
+day). We may suggest some changes or improvements or alternatives.
+
+Some things that will increase the chance that your pull request is accepted,
+taken straight from the Ruby on Rails guide:
+
+* Use Rails idioms and helpers
+* Include tests that fail without your code, and pass with it
+* Update the documentation, the surrounding one, examples elsewhere, guides,
+  whatever is affected by your contribution
+
+Syntax:
+
+* Two spaces, no tabs.
+* No trailing whitespace. Blank lines should not have any space.
+* Prefer &&/|| over and/or.
+* `MyClass.my_method(my_arg)` not `my_method( my_arg )` or `my_method my_arg`.
+* `a = b` and not `a=b`.
+* `a_method { |block| ... }` and not `a_method { | block | ... }`
+* Follow the conventions you see used in the source already.
+* -> symbol over lambda
+* Ruby 1.9 hash syntax over Ruby 1.8 hash syntax
+
+And in case we didn't emphasize it enough: we love tests!

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+gem 'spree', :github => 'spree/spree', :branch => '2-1-stable'
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', :branch => '2-1-stable'
+gem 'sqlite3'
+gem 'pg'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,26 @@
+Copyright (c) 2013 Spree Commerce and contributors.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name Spree nor the names of its contributors may be used to
+      endorse or promote products derived from this software without specific
+      prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,86 @@
+# Spree PayPal Express
+
+This is a "re-do" of the official [spree_paypal_express][4] extension. The old extension is extremely hard to maintain and complex.
+
+Behind-the-scenes, this extension uses [PayPal's Merchant Ruby SDK](https://github.com/paypal/merchant-sdk-ruby).
+
+## Installation
+
+1. Add this extension to your Gemfile with this line:
+
+        gem 'spree_paypal_express', :github => "radar/better_spree_paypal_express", :branch => "2-0-stable"
+
+2. Install the gem using Bundler:
+
+        bundle install
+
+3. Copy & run migrations
+
+        bundle exec rails g spree_paypal_express:install
+
+### Sandbox Setup
+
+#### PayPal
+
+Go to [PayPal's Developer Website](https://developer.paypal.com/), sign in with your PayPal account, click "Applications" then "Sandbox Accounts" and create a new "Business" account. Once the account is created, click on the triangle next to its email address, then "Profile". The "API Credentials" tab will provide your API credentials (probably). If this tab is blank, try refreshing the page.
+
+You will also need a "Personal" account to test the transactions on your site. Create this in the same way, finding the account information under "Profile" as well. You may need to set a password in order to be able to log in to PayPal's sandbox for this user.
+
+#### Spree Setup
+
+In Spree, go to the admin backend, click "Configuration" and then "Payment Methods" and create a new payment method. Select "Spree::Gateway::PayPalExpress" as the provider, and click "Create". Enter the email address, password and signature from the "API Credentials" tab for the **Business** account on PayPal. 
+
+### Production setup
+
+#### PayPal
+
+Sign in to PayPal, then click "Profile" and then (under "Account Information" on the left), click "API Access". On this page, select "Option 2" and click "View API Signature". The username, password and signature will be displayed on this screen.
+
+If you are unable to find it, then follow [PayPal's own documentation](https://developer.paypal.com/webapps/developer/docs/classic/api/apiCredentials/).
+
+#### Spree Setup
+
+Same as sandbox setup, but change "Server" from "sandbox" to "live".
+
+## Caveats
+
+*Caveat venditor*
+
+Paypal will refuse any order with a zero cost item.
+Any such item will be skipped and not displayed.
+
+PayPal will also refuse any order where item total (before taxes and shipping costs) is zero.
+In this case the PayPal checkout page will simply display "Current order".
+
+## Contributing
+
+In the spirit of [free software][1], **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using prerelease versions
+* by reporting [bugs][2]
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (*no patch is too small*: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by resolving [issues][2]
+* by reviewing patches
+
+Starting point:
+
+* Fork the repo
+* Clone your repo
+* Run `bundle install`
+* Run `bundle exec rake test_app` to create the test application in `spec/dummy`
+* Make your changes
+* Ensure specs pass by running `bundle exec rspec spec`
+* Submit your pull request
+
+Copyright (c) 2013 Spree Commerce and contributors, released under the [New BSD License][3]
+
+[1]: http://www.fsf.org/licensing/essays/free-sw.html
+[2]: https://github.com/spree/better_spree_paypal_express/issues
+[3]: https://github.com/spree/better_spree_paypal_express/tree/master/LICENSE.md
+[4]: https://github.com/spree/spree_paypal_express

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/packagetask'
+require 'rubygems/package_task'
+require 'rspec/core/rake_task'
+require 'spree/testing_support/extension_rake'
+
+RSpec::Core::RakeTask.new
+
+task default: :spec
+
+spec = eval(File.read('spree_paypal_express.gemspec'))
+
+Gem::PackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end
+
+desc 'Generates a dummy app for testing'
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_paypal_express'
+  Rake::Task['extension:test_app'].invoke
+end

data/app/assets/javascripts/admin/spree_paypal_express.js

@@ -0,0 +1,25 @@
+//= require admin/spree_backend
+
+SpreePaypalExpress = {
+  hideSettings: function(paymentMethod) {
+    if (SpreePaypalExpress.paymentMethodID && paymentMethod.val() == SpreePaypalExpress.paymentMethodID) {
+      $('.payment-method-settings').children().hide();
+      $('#payment_amount').attr('disabled', 'disabled');
+      $('button[type="submit"]').attr('disabled', 'disabled');
+      $('#paypal-warning').show();
+    } else if (SpreePaypalExpress.paymentMethodID) {
+      $('.payment-method-settings').children().show();
+      $('button[type=submit]').attr('disabled', '');
+      $('#payment_amount').attr('disabled', '')
+      $('#paypal-warning').hide();
+    }
+  }
+}
+
+$(document).ready(function() {
+  checkedPaymentMethod = $('#payment-methods input[type="radio"]:checked');
+  SpreePaypalExpress.hideSettings(checkedPaymentMethod);
+  paymentMethods = $('#payment-methods input[type="radio"]').click(function (e) {
+    SpreePaypalExpress.hideSettings($(e.target));
+  });
+})

data/app/assets/javascripts/store/spree_paypal_express.js

@@ -0,0 +1,19 @@
+//= require store/spree_frontend
+
+SpreePaypalExpress = {
+  hidePaymentSaveAndContinueButton: function(paymentMethod) {
+    if (SpreePaypalExpress.paymentMethodID && paymentMethod.val() == SpreePaypalExpress.paymentMethodID) {
+      $('.continue').hide();
+    } else {
+      $('.continue').show();
+    }
+  }
+}
+
+$(document).ready(function() {
+  checkedPaymentMethod = $('div[data-hook="checkout_payment_step"] input[type="radio"]:checked');
+  SpreePaypalExpress.hidePaymentSaveAndContinueButton(checkedPaymentMethod);
+  paymentMethods = $('div[data-hook="checkout_payment_step"] input[type="radio"]').click(function (e) {
+    SpreePaypalExpress.hidePaymentSaveAndContinueButton($(e.target));
+  });
+})

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

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

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

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

data/app/controllers/spree/admin/payments_controller_decorator.rb

@@ -0,0 +1,19 @@
+Spree::Admin::PaymentsController.class_eval do
+  def paypal_refund
+    if request.get?
+      if @payment.source.state == 'refunded'
+        flash[:error] = Spree.t(:already_refunded, :scope => 'paypal')
+        redirect_to admin_order_payment_path(@order, @payment)
+      end
+    elsif request.post?
+      response = @payment.payment_method.refund(@payment, params[:refund_amount])
+      if response.success?
+        flash[:success] = Spree.t(:refund_successful, :scope => 'paypal')
+        redirect_to admin_order_payments_path(@order)
+      else
+        flash.now[:error] = Spree.t(:refund_unsuccessful, :scope => 'paypal') + " (#{response.errors.first.long_message})"
+        render
+      end
+    end
+  end
+end

data/app/controllers/spree/admin/paypal_payments_controller.rb

@@ -0,0 +1,15 @@
+module Spree
+  class Admin::PaypalPaymentsController < Spree::Admin::BaseController
+    before_filter :load_order
+
+    def index
+      @payments = @order.payments.includes(:payment_method).where(:spree_payment_methods => { :type => "Spree::Gateway::PayPalExpress" })
+    end
+
+    private
+
+    def load_order
+      @order = Spree::Order.where(:number => params[:order_id]).first
+    end
+  end
+end

data/app/controllers/spree/paypal_controller.rb

@@ -0,0 +1,144 @@
+module Spree
+  class PaypalController < StoreController
+    def express
+      items = current_order.line_items.map do |item|
+        {
+          :Name => item.product.name,
+          :Quantity => item.quantity,
+          :Amount => {
+            :currencyID => current_order.currency,
+            :value => item.price
+          },
+          :ItemCategory => "Physical"
+        }
+      end
+
+      tax_adjustments = current_order.adjustments.tax
+      shipping_adjustments = current_order.adjustments.shipping
+
+      current_order.adjustments.eligible.each do |adjustment|
+        next if (tax_adjustments + shipping_adjustments).include?(adjustment)
+        items << {
+          :Name => adjustment.label,
+          :Quantity => 1,
+          :Amount => {
+            :currencyID => current_order.currency,
+            :value => adjustment.amount
+          }
+        }
+      end
+
+      # Because PayPal doesn't accept $0 items at all.
+      # See #10
+      # https://cms.paypal.com/uk/cgi-bin/?cmd=_render-content&content_ID=developer/e_howto_api_ECCustomizing
+      # "It can be a positive or negative value but not zero."
+      items.reject! do |item|
+        item[:Amount][:value].zero?
+      end
+
+      pp_request = provider.build_set_express_checkout({
+        :SetExpressCheckoutRequestDetails => {
+          :ReturnURL => confirm_paypal_url(:payment_method_id => params[:payment_method_id]),
+          :CancelURL =>  cancel_paypal_url,
+          :PaymentDetails => [payment_details(items)]
+        }})
+
+      begin
+        pp_response = provider.set_express_checkout(pp_request)
+        if pp_response.success?
+          redirect_to provider.express_checkout_url(pp_response)
+        else
+          flash[:error] = "PayPal failed. #{pp_response.errors.map(&:long_message).join(" ")}"
+          redirect_to checkout_state_path(:payment)
+        end
+      rescue SocketError
+        flash[:error] = "Could not connect to PayPal."
+        redirect_to checkout_state_path(:payment)
+      end
+    end
+
+    def confirm
+      order = current_order
+      order.payments.create!({
+        :source => Spree::PaypalExpressCheckout.create({
+          :token => params[:token],
+          :payer_id => params[:PayerID]
+        } ),
+        :amount => order.total,
+        :payment_method => payment_method
+      } )
+      order.next
+      if order.complete?
+        flash.notice = Spree.t(:order_processed_successfully)
+        redirect_to order_path(order, :token => order.token)
+      else
+        redirect_to checkout_state_path(order.state)
+      end
+    end
+
+    def cancel
+      flash[:notice] = "Don't want to use PayPal? No problems."
+      redirect_to checkout_state_path(current_order.state)
+    end
+
+    private
+
+    def payment_method
+      Spree::PaymentMethod.find(params[:payment_method_id])
+    end
+
+    def provider
+      payment_method.provider
+    end
+
+    def payment_details items
+      item_sum = items.sum { |i| i[:Quantity] * i[:Amount][:value] }
+      if item_sum.zero?
+        # Paypal does not support no items or a zero dollar ItemTotal
+        # This results in the order summary being simply "Current purchase"
+        {
+          :OrderTotal => {
+            :currencyID => current_order.currency,
+            :value => current_order.total
+          }
+        }
+      else
+        {
+          :OrderTotal => {
+            :currencyID => current_order.currency,
+            :value => current_order.total
+          },
+          :ItemTotal => {
+            :currencyID => current_order.currency,
+            :value => item_sum
+          },
+          :ShippingTotal => {
+            :currencyID => current_order.currency,
+            :value => current_order.ship_total
+          },
+          :TaxTotal => {
+            :currencyID => current_order.currency,
+            :value => current_order.tax_total
+          },
+          :ShipToAddress => address_options,
+          :PaymentDetailsItem => items,
+          :ShippingMethod => "Shipping Method Name Goes Here",
+          :PaymentAction => "Sale"
+        }
+      end
+    end
+
+    def address_options
+      {
+        :Name => current_order.bill_address.try(:full_name),
+        :Street1 => current_order.bill_address.address1,
+        :Street2 => current_order.bill_address.address2,
+        :CityName => current_order.bill_address.city,
+        # :phone => current_order.bill_address.phone,
+        :StateOrProvince => current_order.bill_address.state_text,
+        :Country => current_order.bill_address.country.iso,
+        :PostalCode => current_order.bill_address.zipcode
+      }
+    end
+  end
+end