spree_gateway 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50ad44879ca397e039ab396b063241006925fce0
-  data.tar.gz: 224d9ae94bfe3a7dd324db122a2988ec26b6a716
+  metadata.gz: 95c7ba85f1dc043286f155159fb7b99920b5380c
+  data.tar.gz: 0b3b9ea6327a6dd7e9bd178da097d4328806520b
 SHA512:
-  metadata.gz: 472a5bfd901937d9b5c7048263508c0faeece816a1b30f8c2915a314198db16bec3a711705b0289212702162d321e48dfd8f9fa2fc30490a520df543b3bd3dc5
-  data.tar.gz: 7ebb70dc0b23a8e6c1603fffab875c812875e2c14237d9dd54f7a9f9b13ccbe77393c8c73933aa50a8b30ede8177ba3070c0ac1c7cbab528e111b867500c56f2
+  metadata.gz: f8ae2294899c1db7f01b118c7a627233bb16653bef5878e7e9b4ca50521ebc9b1a86e05f45bf2b43c3fea2e6dee6315ac4087caad57d58e19dc5f31dd0f30949
+  data.tar.gz: 460ffbd59ecea4aef14c93a052dc1ef011d8c1f48ae95c88213a4dcf05209071f7600ecb8a4cbaa05eabcbae136f5b1dab0bf004208da574e590a047dafa7f0a

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--colour

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+before_script:
+  - sh -e /etc/init.d/xvfb start
+  - export DISPLAY=:99.0
+  - bundle exec rake test_app
+env:
+  - DB=sqlite
+  - DB=mysql
+  - DB=postgres
+script:
+  - bundle exec rspec spec
+notifications:
+  email:
+    - ryan@spreecommerce.com
+  irc:
+    use_notice: true
+    skip_join: true
+    channels:
+      - "irc.freenode.org#spree"
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'spree', github: 'spree/spree', branch: '2-2-stable'
+
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+guard "rspec", cmd: "bundle exec rspec", all_after_pass: false, all_on_start: false do
+  watch("spec/spec_helper.rb")                        { "spec" }
+  watch("config/routes.rb")                           { "spec/controllers" }
+  watch(%r{^spec/(.+)_spec\.rb$})                     { |m| "spec/#{m[1]}_spec.rb"}
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)\.erb$})                          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb" }
+end

data/LICENSE.md

@@ -0,0 +1,26 @@
+Copyright (c) 2014 Spree Commerce Inc. and other 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,71 @@
+# Spree Gateway
+
+[![Build Status](https://api.travis-ci.org/spree/spree_gateway.png?branch=master)](https://travis-ci.org/spree/spree_gateway)
+[![Code Climate](https://codeclimate.com/github/spree/spree_gateway.png)](https://codeclimate.com/github/spree/spree_gateway)
+
+Community supported Spree Payment Method Gateways.
+
+These can be used with Spree >= 1.0.x (but see note below for necessary changes)
+
+http://guides.spreecommerce.com/developer/payments.html
+
+## Installation
+
+In your Gemfile:
+
+**Spree edge**
+
+```ruby
+gem 'spree'
+gem 'spree_gateway', github: 'spree/spree_gateway', branch: 'master'
+```
+
+**Spree 1.3**
+
+```ruby
+gem 'spree', '~> 1.3'
+gem 'spree_gateway', github: 'spree/spree_gateway', branch: '1-3-stable'
+```
+
+**Note:** *Please consult the Versionfile at the root of the repository to determine which branch to use.*
+
+Then run from the command line:
+
+    $ bundle install
+    $ rails g spree_gateway:install
+
+Finally, make sure to **restart your app**. Navigate to *Configuration > Payment Methods > New Payment Method* in the admin panel and you should see that a bunch of additional gateways have been added to the list.
+
+## 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`
+* Run `bundle exec rake test_app` to create the test application in `spec/test_app`
+* Make your changes
+* Ensure specs pass by running `bundle exec rspec spec`
+* Submit your pull request
+
+Copyright (c) 2014 [Spree Commerce][4] and other [contributors][5], released under the [New BSD License][3]
+
+[1]: http://www.fsf.org/licensing/essays/free-sw.html
+[2]: https://github.com/spree/spree_gateway/issues
+[3]: https://github.com/spree/spree_gateway/blob/master/LICENSE.md
+[4]: https://github.com/spree
+[5]: https://github.com/spree/spree_gateway/graphs/contributors

data/Rakefile

@@ -0,0 +1,15 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+require 'spree/testing_support/common_rake'
+
+RSpec::Core::RakeTask.new
+
+task :default => [:spec]
+
+desc "Generates a dummy app for testing"
+task :test_app do
+  ENV['LIB_NAME'] = 'spree_gateway'
+  Rake::Task['common:test_app'].invoke
+end

data/Versionfile

@@ -0,0 +1,7 @@
+"2.2.x" => { :branch => "2-2-stable" }
+"2.1.x" => { :branch => "2-1-stable" }
+"2.0.x" => { :branch => "2-0-stable" }
+"1.3.x" => { :branch => "1-3-stable" }
+"1.2.x" => { :branch => "1-2-stable" }
+"1.1.x" => { :branch => "1-1-stable" }
+"1.0.x" => { :branch => "1-0-stable" }

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

@@ -0,0 +1,3 @@
+/* needs to exist for the feature specs to be happy
+  = require spree/frontend
+*/

data/app/assets/javascripts/store/gateway/stripe.js.coffee

@@ -0,0 +1,58 @@
+# Inspired by https://stripe.com/docs/stripe.js
+
+# Map cc types from stripe to spree
+mapCC = (ccType) ->
+  if (ccType == 'MasterCard')
+    'mastercard'
+  else if (ccType == 'Visa')
+    'visa'
+  else if (ccType == 'American Express')
+    'amex'
+  else if (ccType == 'Discover')
+    'discover'
+  else if (ccType == 'Diners Club')
+    'dinersclub'
+  else if (ccType == 'JCB')
+    'jcb'
+
+
+$(document).ready ->
+  # For errors that happen later.
+  Spree.stripePaymentMethod.prepend("<div id='stripeError' class='errorExplanation' style='display:none'></div>")
+
+  $('.continue').click ->
+    $('#stripeError').hide()
+    if Spree.stripePaymentMethod.is(':visible')
+      expiration = $('.cardExpiry:visible').payment('cardExpiryVal')
+      params = $.extend(
+        {
+          number: $('.cardNumber:visible').val(),
+          cvc: $('.cardCode:visible').val(),
+          exp_month: expiration.month || 0,
+          exp_year: expiration.year || 0,
+        },
+        Spree.stripeAdditionalInfo
+      )
+
+      Stripe.card.createToken(params, stripeResponseHandler);
+      return false
+
+stripeResponseHandler = (status, response) ->
+  if response.error
+    $('#stripeError').html(response.error.message)
+    $('#stripeError').show()
+  else
+    Spree.stripePaymentMethod.find('#card_number, #card_expiry, #card_code').prop("disabled" , true)
+    Spree.stripePaymentMethod.find(".ccType").prop("disabled", false)
+    Spree.stripePaymentMethod.find(".ccType").val(mapCC(response.card.type))
+
+    # token contains id, last4, and card type
+    token = response['id'];
+    # insert the token into the form so it gets submitted to the server
+    paymentMethodId = Spree.stripePaymentMethod.prop('id').split("_")[2]
+    Spree.stripePaymentMethod.append("<input type='hidden' class='stripeToken' name='payment_source[" + paymentMethodId  + "][gateway_payment_profile_id]' value='" + token + "'/>");
+    Spree.stripePaymentMethod.append("<input type='hidden' class='stripeToken' name='payment_source[" + paymentMethodId  + "][last_digits]' value='" + response.card.last4 + "'/>");
+    Spree.stripePaymentMethod.append("<input type='hidden' class='stripeToken' name='payment_source[" + paymentMethodId  + "][month]' value='" + response.card.exp_month + "'/>");
+    Spree.stripePaymentMethod.append("<input type='hidden' class='stripeToken' name='payment_source[" + paymentMethodId  + "][year]' value='" + response.card.exp_year + "'/>");
+    # Spree.stripePaymentMethod.append("<input type='hidden' class='stripeToken' name='payment_source[" + paymentMethodId  + "][cc_type]' value='" + mapCC(response.card.type) + "'/>");
+    Spree.stripePaymentMethod.parents("form").get(0).submit();

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

@@ -0,0 +1,2 @@
+//= require spree
+//= require store/checkout

data/app/assets/stylesheets/spree/frontend/spree_gateway.css

@@ -0,0 +1,3 @@
+/*
+ *= require spree/frontend
+*/

data/app/controllers/spree/checkout_controller_decorator.rb

@@ -0,0 +1,51 @@
+module Spree
+  CheckoutController.class_eval do
+    before_filter :confirm_skrill, :only => [:update]
+
+    def skrill_return
+
+      unless @order.payments.where(:source_type => 'Spree::SkrillTransaction').present?
+        payment_method = PaymentMethod.find(params[:payment_method_id])
+        skrill_transaction = SkrillTransaction.new
+
+        payment = @order.payments.create({:amount => @order.total,
+                                         :source => skrill_transaction,
+                                         :payment_method => payment_method},
+                                         :without_protection => true)
+        payment.started_processing!
+        payment.pend!
+      end
+
+      @order.update_attributes({:state => "complete", :completed_at => Time.now}, :without_protection => true)
+
+      until @order.state == "complete"
+        if @order.next!
+          @order.update!
+          state_callback(:after)
+        end
+      end
+
+      @order.finalize!
+
+      flash.notice = Spree.t(:order_processed_successfully)
+      redirect_to completion_route
+    end
+
+    def skrill_cancel
+      flash[:error] = Spree.t(:payment_has_been_cancelled)
+      redirect_to edit_order_path(@order)
+    end
+
+    private
+    def confirm_skrill
+      return unless (params[:state] == "payment") && params[:order][:payments_attributes]
+
+      payment_method = PaymentMethod.find(params[:order][:payments_attributes].first[:payment_method_id])
+      if payment_method.kind_of?(BillingIntegration::Skrill::QuickCheckout)
+        #TODO confirming payment method
+        redirect_to edit_order_checkout_url(@order, :state => 'payment'),
+                    :notice => Spree.t(:complete_skrill_checkout)
+      end
+    end
+  end
+end

data/app/controllers/spree/skrill_status_controller.rb

@@ -0,0 +1,39 @@
+module Spree
+  class SkrillStatusController < ApplicationController
+    def update
+      @order = Order.find_by_number!(params[:order_id])
+      payment_method = PaymentMethod.find(params[:payment_method_id])
+      skrill_transaction = SkrillTransaction.create_from_postback params
+
+      payment = @order.payments.where(:state => "pending",
+                                      :payment_method_id => payment_method).first
+
+      if payment
+        payment.source = skrill_transaction
+        payment.save
+      else
+        payment = @order.payments.create(:amount => @order.total,
+                                         :source => skrill_transaction,
+                                         :payment_method => payment_method)
+      end
+
+      payment.started_processing!
+
+       unless payment.completed?
+        case params[:status]
+          when "0"
+            payment.pend #may already be pending
+          when "2" #processed / captured
+            payment.complete!
+          when "-1", "-2"
+            payment.failure!
+          else
+            raise "Unexpected payment status"
+        end
+      end
+
+      render :text => ""
+    end
+
+  end
+end

data/app/models/spree/billing_integration/skrill/quick_checkout.rb

@@ -0,0 +1,48 @@
+module Spree
+  class BillingIntegration::Skrill::QuickCheckout < BillingIntegration
+    preference :merchant_id, :string
+    preference :language, :string, :default => 'EN'
+    preference :currency, :string, :default => 'EUR'
+    preference :payment_options, :string, :default => 'ACC'
+    preference :pay_to_email, :string ,   :default => 'your@merchant.email_here'
+
+    def provider_class
+      ActiveMerchant::Billing::Skrill
+    end
+
+    def redirect_url(order, opts = {})
+      opts.merge! self.preferences
+
+      set_global_options(opts)
+
+      opts[:detail1_text] = order.number
+      opts[:detail1_description] = "Order:"
+
+      opts[:pay_from_email] = order.email
+      opts[:firstname] = order.bill_address.firstname
+      opts[:lastname] = order.bill_address.lastname
+      opts[:address] = order.bill_address.address1
+      opts[:address2] = order.bill_address.address2
+      opts[:phone_number] = order.bill_address.phone.gsub(/\D/,'') if order.bill_address.phone
+      opts[:city] = order.bill_address.city
+      opts[:postal_code] = order.bill_address.zipcode
+      opts[:state] = order.bill_address.state.nil? ? order.bill_address.state_name.to_s : order.bill_address.state.abbr
+      opts[:country] = order.bill_address.country.name
+      opts[:pay_to_email] = self.preferred_pay_to_email
+      opts[:hide_login] = 1
+      opts[:merchant_fields] = 'platform,order_id,payment_method_id'
+      opts[:platform] = 'Spree'
+      opts[:order_id] = order.number
+
+      skrill = self.provider
+      skrill.payment_url(opts)
+    end
+
+    private
+      def set_global_options(opts)
+        opts[:recipient_description] = Spree::Config[:site_name]
+        opts[:payment_methods] = self.preferred_payment_options
+      end
+
+  end
+end

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

@@ -0,0 +1,16 @@
+module Spree
+  class Gateway::AuthorizeNet < Gateway
+    preference :login, :string
+    preference :password, :string
+
+    def provider_class
+      ActiveMerchant::Billing::AuthorizeNetGateway
+    end
+
+    def options_with_test_preference
+      options_without_test_preference.merge(:test => self.preferred_test_mode)
+    end
+
+    alias_method_chain :options, :test_preference
+  end
+end

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

@@ -0,0 +1,132 @@
+module Spree
+  class Gateway::AuthorizeNetCim < Gateway
+    preference :login, :string
+    preference :password, :string
+    preference :test_mode, :boolean, :default => false
+    preference :validate_on_profile_create, :boolean, :default => false
+
+    ActiveMerchant::Billing::Response.class_eval do
+      attr_writer :authorization
+    end
+
+    def provider_class
+      self.class
+    end
+
+    def options
+      # add :test key in the options hash, as that is what the ActiveMerchant::Billing::AuthorizeNetGateway expects
+      if self.preferred_test_mode
+        self.class.preference :test, :boolean, :default => true
+      else
+        self.class.remove_preference :test
+      end
+
+      super
+    end
+
+    def authorize(amount, creditcard, gateway_options)
+      t_options = { :order => {:invoice_number => gateway_options[:order_id] } }
+       create_transaction( amount, creditcard, :auth_only, t_options )
+    end
+
+    def purchase(amount, creditcard, gateway_options)
+      create_transaction(amount, creditcard, :auth_capture)
+    end
+
+    def capture(authorization, creditcard, gateway_options)
+      create_transaction((authorization.amount * 100).round, creditcard, :prior_auth_capture, :trans_id => authorization.response_code)
+    end
+
+    def credit(amount, creditcard, response_code, gateway_options)
+      create_transaction(amount, creditcard, :refund, :trans_id => response_code)
+    end
+
+    def void(response_code, creditcard, gateway_options)
+      create_transaction(nil, creditcard, :void, :trans_id => response_code)
+    end
+
+    def payment_profiles_supported?
+      true
+    end
+
+    # Create a new CIM customer profile ready to accept a payment
+    def create_profile(payment)
+      if payment.source.gateway_customer_profile_id.nil?
+        profile_hash = create_customer_profile(payment)
+        payment.source.update_attributes(:gateway_customer_profile_id => profile_hash[:customer_profile_id], :gateway_payment_profile_id => profile_hash[:customer_payment_profile_id])
+      end
+    end
+
+    # simpler form
+    def create_profile_from_card(card)
+      if card.gateway_customer_profile_id.nil?
+        profile_hash = create_customer_profile(card)
+        card.update_attributes(:gateway_customer_profile_id => profile_hash[:customer_profile_id], :gateway_payment_profile_id => profile_hash[:customer_payment_profile_id])
+      end
+    end
+
+    private
+      # Create a transaction on a creditcard
+      # Set up a CIM profile for the card if one doesn't exist
+      # Valid transaction_types are :auth_only, :capture_only and :auth_capture
+      def create_transaction(amount, creditcard, transaction_type, options = {})
+        #create_profile(creditcard, creditcard.gateway_options)
+        creditcard.save
+        if amount
+          amount = "%.2f" % (amount / 100.0) # This gateway requires formated decimal, not cents
+        end
+        transaction_options = {
+          :type => transaction_type,
+          :amount => amount,
+          :customer_profile_id => creditcard.gateway_customer_profile_id,
+          :customer_payment_profile_id => creditcard.gateway_payment_profile_id,
+        }.update(options)
+        t = cim_gateway.create_customer_profile_transaction(:transaction => transaction_options)
+        logger.debug("\nAuthorize Net CIM Transaction")
+        logger.debug("  transaction_options: #{transaction_options.inspect}")
+        logger.debug("  response: #{t.inspect}\n")
+        t
+      end
+
+      # Create a new CIM customer profile ready to accept a payment
+      def create_customer_profile(payment)
+        options = options_for_create_customer_profile(payment)
+        response = cim_gateway.create_customer_profile(options)
+        if response.success?
+          { :customer_profile_id => response.params['customer_profile_id'],
+            :customer_payment_profile_id => response.params['customer_payment_profile_id_list'].values.first }
+        else
+          payment.send(:gateway_error, response)
+        end
+      end
+
+      def options_for_create_customer_profile(payment)
+        if payment.is_a? CreditCard
+          info = { :bill_to => generate_address_hash(payment.address), :payment => { :credit_card => payment } }
+        else
+          info = { :bill_to => generate_address_hash(payment.order.bill_address),
+                   :payment => { :credit_card => payment.source } }
+        end
+        validation_mode = preferred_validate_on_profile_create ? preferred_server.to_sym : :none
+
+        { :profile => { :merchant_customer_id => "#{Time.now.to_f}",
+                        #:ship_to_list => generate_address_hash(creditcard.checkout.ship_address),
+                        :email => payment.order.email,
+                        :payment_profiles => info },
+          :validation_mode => validation_mode }
+      end
+
+      # As in PaymentGateway but with separate name fields
+      def generate_address_hash(address)
+        return {} if address.nil?
+        {:first_name => address.firstname, :last_name => address.lastname, :address1 => address.address1, :address2 => address.address2, :city => address.city,
+         :state => address.state_text, :zip => address.zipcode, :country => address.country.iso, :phone_number => address.phone}
+      end
+
+      def cim_gateway
+        ActiveMerchant::Billing::Base.gateway_mode = preferred_server.to_sym
+        gateway_options = options
+        ActiveMerchant::Billing::AuthorizeNetCimGateway.new(gateway_options)
+      end
+  end
+end