spree_affirm 0.2.19 → 0.2.20

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

@@ -0,0 +1,58 @@
+module Spree
+  class Gateway::Affirm < Gateway
+    preference :api_key, :string
+    preference :secret_key, :string
+    preference :server, :string, default: 'www.affirm.com'
+    preference :product_key, :string
+
+    def provider_class
+      ActiveMerchant::Billing::Affirm
+    end
+
+    def payment_source_class
+      Spree::AffirmCheckout
+    end
+
+    def source_required?
+      true
+    end
+
+    def method_type
+      'affirm'
+    end
+
+    def actions
+      %w{capture void credit}
+    end
+
+    def supports?(source)
+      source.is_a? payment_source_class
+    end
+
+    def self.version
+      Gem::Specification.find_by_name('spree_affirm').version.to_s
+    end
+
+    def cancel(charge_ari)
+      _payment = Spree::Payment.valid.where(
+        response_code: charge_ari,
+        source_type:   "#{payment_source_class}"
+      ).first
+
+      return if _payment.nil?
+
+      if _payment.pending?
+        _payment.void_transaction!
+
+      elsif _payment.completed? and _payment.can_credit?
+
+        # create adjustment
+        _payment.order.adjustments.create label: "Refund - Canceled Order", amount: -_payment.credit_allowed.to_f
+        _payment.order.update!
+
+        _payment.credit!
+
+      end
+    end
+  end
+end

data/app/views/spree/admin/log_entries/_affirm.html.erb

@@ -0,0 +1,4 @@
+<tr>
+  <td><%= Spree.t(:message, :scope => [:log_entry, :affirm]) %></td>
+  <td><%= entry.parsed_details.message %></td>
+</tr>

data/app/views/spree/admin/log_entries/index.html.erb

@@ -0,0 +1,28 @@
+<%= render :partial => 'spree/admin/shared/order_tabs', locals: { current: 'Payments' }%>
+
+<% content_for :page_title do %>
+  <i class="icon-arrow-right"></i>
+  <%= I18n.t(:one, scope: "activerecord.models.spree/payment") %>
+  <i class="icon-arrow-right"></i>
+  <%= Spree.t(:log_entries) %>
+<% end %>
+
+<% content_for :page_actions do %>
+  <li><%= button_link_to Spree.t(:logs), spree.admin_order_payment_log_entries_url(@order, @payment), :icon => 'icon-archive' %></li>
+  <li><%= button_link_to Spree.t(:back_to_payment), spree.admin_order_payment_url(@order, @payment), :icon => 'icon-arrow-left' %></li>
+<% end %>
+
+<table class='index' id='listing_log_entries'>
+  <% @log_entries.each do |entry| %>
+      <thead>
+        <tr class="log_entry <%= entry.parsed_details.success? ? 'success' : 'fail' %>">
+          <td colspan='2'>
+            <h4><i class='icon icon-<%= entry.parsed_details.success? ? 'ok-circle' : 'remove-sign' %>'></i> <%= pretty_time(entry.created_at) %></h4>
+          </td>
+        </tr>
+      </thead>
+      <tbody>
+          <%= render "spree/admin/log_entries/#{@payment.payment_method.method_type.gsub(' ', '').underscore}", entry: entry rescue render "spree/admin/log_entries/#{@payment.payment_method.name.gsub(' ', '').underscore}", entry: entry  %>
+      </tbody>
+  <% end %>
+</table>

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

@@ -0,0 +1,19 @@
+<script>
+  function showAffirmError(method_id) {
+    if (method_id === AffirmPaymentMethodID) {
+      $('.payment-method-settings').prepend("<strong id=\"affirm-warning\">You cannot charge Affirm accounts through the admin backend at this time.</strong>");
+    } else {
+      $('#affirm-warning').remove();
+    }
+  }
+  AffirmPaymentMethodID = "<%= payment_method.id %>"
+
+  $(function() {
+    var checked_method_id = $('[data-hook="payment_method_field"] input[type="radio"]:checked').val();
+    showAffirmError(checked_method_id);
+
+    $('[data-hook="payment_method_field"] input[type="radio"]').click(function (e) {
+      showAffirmError($(e.target).val());
+    });
+  })
+</script>

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

@@ -0,0 +1,12 @@
+<fieldset data-hook="credit_card">
+  <legend align="center">Affirm Payment</legend>
+
+  <div class="row">
+      <div class="alpha six columns">
+        <dl>
+            <dt>Charge Id:</dt>
+            <dd><%= payment.response_code %></dd>
+         </dl>
+    </div>
+  </div>
+</fieldset>

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

@@ -0,0 +1,190 @@
+<div class="affirm-learn-more-section">
+  <%= render partial: 'spree/checkout/affirm/learn_more' %>
+</div>
+
+<script>
+(function(){
+  /* only include this setup once */
+  if (!window.AffirmPaymentMethods) {
+
+    /*****************************************************\
+        Include the affirm js snippet
+    \*****************************************************/
+    var _affirm_config = {
+      public_api_key: "<%= payment_method.preferred_api_key %>",
+      script: "https://<%= payment_method.preferred_server %>/js/v2/affirm.js"
+    };
+    (function(l,g,m,e,a,f,b){var d,c=l[m]||{},h=document.createElement(f),n=document.getElementsByTagName(f)[0],k=function(a,b,c){return function(){a[b]._.push([c,arguments])}};c[e]=k(c,e,"set");d=c[e];c[a]={};c[a]._=[];d._=[];c[a][b]=k(c,a,b);a=0;for(b="set add save post open empty reset on off trigger ready setProduct".split(" ");a<b.length;a++)d[b[a]]=k(c,e,b[a]);a=0;for(b=["get","token","url","items"];a<b.length;a++)d[b[a]]=function(){};h.async=!0;h.src=g[f];n.parentNode.insertBefore(h,n);delete g[f];d(g);l[m]=c})(window,_affirm_config,"affirm","checkout","ui","script","ready");
+
+    /*****************************************************\
+        set the shared checkout data
+    \*****************************************************/
+    affirm.checkout({
+      total:                <%= (@order.total * 100).to_i %>,
+      currency:             "USD",
+      tax_amount:           <%= (@order.additional_tax_total * 100).to_i %>,
+      checkout_id:          "<%= @order.number %>",
+      discount_code:        "<%= @order.coupon_code %>",
+      shipping_type:        "<%= @order.shipments.first.shipping_method.name if @order.shipments %>",
+      shipping_amount:      <%= (@order.shipment_total * 100).to_i %>,
+
+      shipping: {
+        name: {
+          full:  "<%= @order.ship_address.full_name %>",
+        },
+        address: {
+          line1:        "<%= @order.ship_address.address1 %>",
+          line2:        "<%= @order.ship_address.address2 %>",
+          city:         "<%= @order.ship_address.city %>",
+          state:        "<%= @order.ship_address.state_text %>",
+          country:      "<%= @order.ship_address.country.iso %>",
+          zipcode:      "<%= @order.ship_address.zipcode %>",
+        }
+      },
+
+      billing: {
+        email: "<%= @order.email %>",
+        name: {
+          full:   "<%= @order.bill_address.full_name %>"
+        },
+        address: {
+          line1:          "<%= @order.bill_address.address1 %>",
+          line2:          "<%= @order.bill_address.address2 %>",
+          city:           "<%= @order.bill_address.city %>",
+          state:          "<%= @order.bill_address.state_text %>",
+          country:        "<%= @order.bill_address.country.iso %>",
+          zipcode:        "<%= @order.bill_address.zipcode %>",
+        }
+      },
+
+
+      meta: {
+        source: {
+          client_name: "spree_affirm",
+          version: "<%= Spree::Gateway::Affirm.version %>",
+          data: {
+            <% if spree_current_user %>
+              order_count: "<%= spree_current_user.orders.complete.count %>",
+              account_created: "<%= spree_current_user.created_at %>",
+
+              <% if spree_current_user.orders.complete.any? %>
+                last_order_date: "<%= spree_current_user.orders.complete.last.completed_at %>",
+              <% end %>
+
+            <% end %>
+            is_logged_in: <%= !!spree_current_user %>,
+            spree_version: "<%= Spree.version %>"
+          }
+        }
+      },
+
+      merchant: {
+        user_confirmation_url:    "<%= confirm_affirm_url(:payment_method_id => payment_method.id) %>",
+        user_cancel_url:          "<%= cancel_affirm_url(:payment_method_id => payment_method.id) %>",
+      },
+
+      config: {
+        required_billing_fields:      "name,address,email",
+      },
+
+
+      <% if @order.promotions.any? %>
+      discounts: {
+        <% @order.promotions.each do |promo| %>
+          "<%= promo.code %>": {
+            discount_amount:       <%= (0-promo.credits.sum(:amount)*100).to_i %>,
+            discount_display_name: "<%= promo.name %>"
+          },
+        <% end %>
+      },
+      <% end %>
+
+      items: [
+        <% @order.line_items.each do |item| %>
+        {
+          <% if item.variant.images.any? %>
+            item_image_url: "<%= URI.join(root_url, item.variant.images.first.attachment.url(:large)) %>",
+          <% elsif item.variant.product.images.any? %>
+            item_image_url: "<%= URI.join(root_url, item.variant.product.images.first.attachment.url(:large)) %>",
+          <% end %>
+
+          qty:           <%= item.quantity %>,
+          sku:           "<%= item.variant.sku %>",
+          item_url:      "<%= product_url(item.product) %>",
+          unit_price:    <%= item.price * 100 %>,
+          display_name:  "<%= raw(item.variant.product.name) %>"
+        },
+        <% end %>
+      ]
+    });
+
+
+    /* wait for the DOM to be ready */
+    affirm.ui.ready(function(){
+      $(function() {
+
+        /*****************************************************\
+            setup loading and cancel events for the form
+        \*****************************************************/
+        affirm.checkout.on("cancel", function(){
+          $("#checkout_form_payment input.disabled")
+            .attr("disabled", false)
+            .removeClass("disabled");
+        });
+
+        var button_text = $("#checkout_form_payment input").val();
+
+        $("#checkout_form_payment input[type='submit']").on("loading", function(){
+          button_text = $(this).val();
+          $(this).val("Loading...");
+        })
+
+        .on("done_loading", function(){
+          $(this).val(button_text);
+        });
+
+
+
+        /*****************************************************\
+            handle continue button clicks with .open()
+        \*****************************************************/
+        $('#checkout_form_payment').submit(function(e){
+          var checkedPaymentMethod = $('div[data-hook="checkout_payment_step"] input[type="radio"]:checked').val();
+
+          if (window.AffirmPaymentMethods[checkedPaymentMethod]) {
+            var $submit_button = $(this).find("input[type='submit']");
+
+            // update with checkout method details
+            affirm.checkout(window.AffirmPaymentMethods[checkedPaymentMethod]);
+
+            // show the loading message
+            $submit_button.trigger("loading");
+
+            // submit the checkout
+            affirm.checkout.open({
+              target: $submit_button
+            });
+
+            e.preventDefault();
+            return false;
+          }
+        });
+      });
+    });
+
+    window.AffirmPaymentMethods = {};
+  }
+
+
+  /*****************************************************\
+      set the product/button specific data to be
+      used when the continue button is directly
+      clicked
+  \*****************************************************/
+  window.AffirmPaymentMethods["<%= payment_method.id %>"] = {
+    public_api_key:           "<%= payment_method.preferred_api_key %>",
+    financial_product_key:    "<%= payment_method.preferred_product_key %>"
+  };
+
+}());
+</script>

data/bin/rails

@@ -0,0 +1,7 @@
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path('../..', __FILE__)
+ENGINE_PATH = File.expand_path('../../lib/spree_affirm/engine', __FILE__)
+
+require 'rails/all'
+require 'rails/engine/commands'

data/config/locales/en.yml

@@ -0,0 +1,31 @@
+# Sample localization file for English. Add more files in this directory for other locales.
+# See https://github.com/svenfuchs/rails-i18n/tree/master/rails%2Flocale for starting points.
+
+en:
+  spree:
+    affirm_checkout: "Affirm Checkout"
+  activerecord:
+    models:
+      "spree/affirm_checkout":
+        "Order size mismatch": "Order size mismatch"
+        "Line Item not in checkout details": "Line Item not in checkout details"
+        "Quantity mismatch": "Quantity mismatch"
+        "Price mismatch": "Price mismatch"
+        "Billing email mismatch": "Billing email mismatch"
+        "Product key mismatch": "Product key mismatch"
+        "city mismatch": "city mismatch"
+        "street1 mismatch": "street1 mismatch"
+        "street2 mismatch": "street2 mismatch"
+        "postal_code mismatch": "postal_code mismatch"
+        "region1_code mismatch": "region1_code mismatch"
+        "First/Last name mismatch": "First/Last name mismatch"
+        "Full name mismatch": "Full name mismatch"
+
+    attributes:
+      "spree/affirm_checkout":
+        line_items: "items"
+        billing_address: "billing address"
+        shipping_address: "shipping address"
+        billing_email: "email"
+        financial_product_key: "Affirm Financial Product"
+

data/config/routes.rb

@@ -0,0 +1,5 @@
+Spree::Core::Engine.routes.draw do
+  # Add your extension routes here
+  post '/affirm/confirm', :to => "affirm#confirm", :as => :confirm_affirm
+  get '/affirm/cancel', :to => "affirm#cancel", :as => :cancel_affirm
+end

data/db/migrate/20140514194315_create_affirm_checkout.rb

@@ -0,0 +1,10 @@
+class CreateAffirmCheckout < ActiveRecord::Migration
+  def change
+    create_table :spree_affirm_checkouts do |t|
+      t.string     :token
+      t.references :order
+      t.references :payment_method
+      t.timestamps
+    end
+  end
+end

data/lib/active_merchant/billing/affirm.rb

@@ -0,0 +1,161 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    class Affirm < Gateway
+      self.supported_countries = %w(US)
+      self.default_currency = 'USD'
+      self.money_format = :cents
+
+      def initialize(options = {})
+          requires!(options, :api_key, :secret_key, :server)
+          @api_key = options[:api_key]
+          @secret_key = options[:secret_key]
+          super
+      end
+
+      def set_charge(charge_id)
+          @charge_id = charge_id
+      end
+
+      def authorize(money, affirm_source, options = {})
+        result = commit(:post, "", {"checkout_token"=>affirm_source.token}, options, true)
+        return result unless result.success?
+
+        if amount(money).to_i != result.params["amount"].to_i
+          return Response.new(false,
+                              "Auth amount does not match charge amount",
+                              result.params
+                             )
+        elsif result.params["pending"].to_s != "true"
+          return Response.new(false,
+                              "There was an error authorizing this Charge",
+                              result.params
+                             )
+        end
+        result
+      end
+
+      # To create a charge on a card or a token, call
+      #
+      #   purchase(money, card_hash_or_token, { ... })
+      #
+      # To create a charge on a customer, call
+      #
+      #   purchase(money, nil, { :customer => id, ... })
+      def purchase(money, affirm_source, options = {})
+          result = authorize(money, affirm_source, options)
+          return result unless result.success?
+          capture(money, @charge_id, options)
+      end
+
+      def capture(money, charge_source, options = {})
+        post = {:amount => amount(money)}
+        set_charge(charge_source)
+        result = commit(:post, "#{@charge_id}/capture", post, options)
+        return result unless result.success?
+
+        if amount(money).to_i != result.params["amount"].to_i
+          return Response.new(false,
+                "Capture amount does not match charge amount",
+                result.params
+                )
+        end
+        result
+      end
+
+      def void(charge_source, options = {})
+        set_charge(charge_source)
+        commit(:post, "#{@charge_id}/void", {}, options)
+      end
+
+      def refund(money, charge_source, options = {})
+        post = {:amount => amount(money)}
+        set_charge(charge_source)
+        commit(:post, "#{@charge_id}/refund", post, options)
+      end
+
+      def credit(money, charge_source, options = {})
+          set_charge(charge_source)
+          return Response.new(true ,
+                       "Credited Zero amount",
+                       {},
+                       :authorization => @charge_id,
+                      ) unless money > 0
+          refund(money, charge_source, options)
+      end
+
+      def root_url
+        "#{root_api_url}charges/"
+      end
+
+      def root_api_url
+        "https://#{@options[:server]}/api/v2/"
+      end
+
+      def headers
+          {
+              "Content-Type" => "application/json",
+              "Authorization" => "Basic " + Base64.encode64(@api_key.to_s + ":" + @secret_key.to_s).gsub(/\n/, '').strip,
+              "User-Agent" => "Affirm/v1 ActiveMerchantBindings",
+          }
+      end
+
+      def parse(body)
+        JSON.parse(body)
+      end
+
+      def post_data(params)
+        return nil unless params
+        params.to_json
+      end
+
+      def response_error(raw_response)
+        begin
+          parse(raw_response)
+        rescue JSON::ParserError
+          json_error(raw_response)
+        end
+      end
+
+      def json_error(raw_response)
+        msg = 'Invalid response.  Please contact affirm if you continue to receive this message.'
+        msg += "  (The raw response returned by the API was #{raw_response.inspect})"
+        {
+          "error" => {
+            "message" => msg
+          }
+        }
+      end
+
+      def get_checkout(checkout_token)
+        _url           = root_api_url + "checkout/#{checkout_token}"
+        _raw_response  = ssl_request :get, _url, nil, headers
+
+        parse(_raw_response)
+      end
+
+      def commit(method, url, parameters=nil, options = {}, ret_charge=false)
+          raw_response = response = nil
+          success = false
+          begin
+              raw_response = ssl_request(method, root_url + url, post_data(parameters), headers)
+              response = parse(raw_response)
+              success = !response.key?("status_code") && (!ret_charge || response.key?("id"))
+          rescue ResponseError => e
+              raw_response = e.response.body
+              response = response_error(raw_response)
+          rescue JSON::ParserError
+              response = json_error(raw_response)
+          end
+
+          if success && ret_charge
+              @charge_id = response["id"]
+          end
+          Response.new(success,
+                       success ? "Transaction approved" : response["message"],
+                       response,
+                       :authorization => @charge_id,
+                      )
+      end
+    end
+  end
+end