spree_affirm 0.2.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 960cab60304d9c975f1b96c7dd949cc336d5fccf559b02fd41613556169831ab
+  data.tar.gz: '09c73710797e4961e7f3839474fb0c559165f38d75d98f1d4935c188102ccdca'
+SHA512:
+  metadata.gz: 6b43bf2de8cdd3012af7320f56fb5b0ad327c15c7fc9b5d5d80036b86d1dd407f5025f52b3ed2d550a33d842a38212eeff07dc928d96d05bab6570f9d37ea0af
+  data.tar.gz: df9bff0eebd0b99e5ce7f3faa973fab0ec511c3eab78db2df3607a21ccbd2cdd049ab88164dce85c4ee49f7067a1fa2f5be5b950cf55ecb3e94ba8a8784639a0

data/.gitignore

@@ -0,0 +1,15 @@
+\#*
+*~
+.#*
+.DS_Store
+.idea
+.project
+.sass-cache
+coverage
+Gemfile.lock
+tmp
+nbproject
+pkg
+*.swp
+spec/dummy
+.rspec

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+gem 'spree', github: 'spree/spree', tag: 'v0.2.25'
+gem 'spree_gateway', github: 'spree/spree_gateway', tag: 'v0.2.25'
+gem 'spree_auth_devise', github: 'spree/spree_auth_devise', tag: 'v0.2.25'
+
+group :test do
+  gem 'coffee-rails'
+  gem 'sass-rails', '~> 4.0.3'
+  gem 'money', '6.5.1'
+  gem 'rspec-rails', '~> 2.10'
+  gem 'shoulda-matchers', '2.2.0'
+  gem 'simplecov', :require => false
+  gem 'simplecov-rcov'
+  gem 'database_cleaner'
+  gem 'minitest'
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2019, Affirm
+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 of the copyright holder 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 HOLDER 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,51 @@
+SpreeAffirm
+===========
+
+Installation
+------------
+
+1. Add this extension to your Gemfile with this line:
+
+    gem 'spree_affirm', :github => "affirm/spree_affirm"
+
+2. Install the gem using Bundler:
+
+        bundle install
+
+3. Copy & run migrations
+
+        bundle exec rails g spree_affirm:install
+
+4. Restart your server
+
+Documentation
+------------------
+https://docs.affirm.com/Spree
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (```git checkout -b my-new-feature```).
+3. Commit your changes (```git commit -am 'Added some feature'```)
+4. Push to the branch (```git push origin my-new-feature```)
+5. Create new Pull Request
+
+Testing
+-------
+
+Be sure to bundle your dependencies and then create a dummy test app for the specs to run against.
+
+```shell
+bundle
+bundle exec rake test_app
+bundle exec rspec spec
+```
+
+When testing your applications integration with this extension you may use its factories.
+Simply add this require statement to your spec_helper:
+
+```ruby
+require 'spree_affirm/factories'
+```
+
+Copyright (c) 2019 Affirm, released under the New BSD License

data/Rakefile

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

data/Versionfile

@@ -0,0 +1,5 @@
+# This file is used to designate compatibilty with different versions of Spree
+# Please see http://spreecommerce.com/documentation/extensions.html#versionfile for details
+
+"2.2.x" => { :branch => "master" }
+"2.0.x" => { :branch => "2-0-stable" }

data/app/assets/javascripts/spree/backend/spree_affirm.js

@@ -0,0 +1,3 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/backend/all.js'
+//

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

@@ -0,0 +1,2 @@
+// Placeholder manifest file.
+// the installer will append this file to the app vendored assets here: vendor/assets/javascripts/spree/frontend/all.js'

data/app/assets/stylesheets/spree/backend/spree_affirm.css

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/backend/all.css'
+*/

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

@@ -0,0 +1,4 @@
+/*
+Placeholder manifest file.
+the installer will append this file to the app vendored assets here: 'vendor/assets/stylesheets/spree/frontend/all.css'
+*/

data/app/controllers/spree/affirm_controller.rb

@@ -0,0 +1,68 @@
+module Spree
+  class AffirmController < Spree::StoreController
+    helper 'spree/orders'
+
+    #the confirm will do it's own protection by making calls to affirm
+    protect_from_forgery :except => [:confirm]
+
+    def confirm
+      order = current_order || raise(ActiveRecord::RecordNotFound)
+
+      if !params[:checkout_token]
+        flash[:notice] = "Invalid order confirmation data."
+        return redirect_to checkout_state_path(current_order.state)
+      end
+
+      if order.complete?
+        flash[:notice] = "Order already completed."
+        return redirect_to completion_route order
+      end
+
+      _affirm_checkout = Spree::AffirmCheckout.new(
+        order: order,
+        token: params[:checkout_token],
+        payment_method: payment_method
+      )
+
+      order.save
+
+      _affirm_checkout.save
+
+      _affirm_payment = order.payments.create!({
+        payment_method: payment_method,
+        amount: order.total,
+        source: _affirm_checkout
+      })
+
+      # transition to confirm or complete
+      order.next
+
+      if order.completed?
+        session[:order_id] = nil
+        flash.notice = Spree.t(:order_processed_successfully)
+        flash[:order_completed] = true
+        redirect_to completion_route order
+      else
+        redirect_to checkout_state_path(order.state)
+      end
+    end
+
+    def cancel
+      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 completion_route(order)
+      spree.order_path(order)
+    end
+  end
+end

data/app/models/spree/affirm_checkout.rb

@@ -0,0 +1,38 @@
+module Spree
+  class AffirmCheckout < ActiveRecord::Base
+    belongs_to :payment_method
+    belongs_to :order
+
+    scope :with_payment_profile, -> { all }
+
+    def name
+      "Affirm Checkout"
+    end
+
+    def details
+      @details ||= payment_method.provider.get_checkout token
+    end
+
+    def actions
+      %w{capture void credit}
+    end
+
+    # Indicates whether its possible to capture the payment
+    def can_capture?(payment)
+      (payment.pending? || payment.checkout?) && !payment.response_code.blank?
+    end
+
+    # Indicates whether its possible to void the payment.
+    def can_void?(payment)
+      !payment.void? && payment.pending? && !payment.response_code.blank?
+    end
+
+    # Indicates whether its possible to credit the payment.  Note that most gateways require that the
+    # payment be settled first which generally happens within 12-24 hours of the transaction.
+    def can_credit?(payment)
+      return false unless payment.completed?
+      return false unless payment.order.payment_state == 'credit_owed'
+      payment.credit_allowed > 0
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+module Spree
+  class Gateway::Affirm < Gateway
+    preference :api_key, :string
+    preference :secret_key, :string
+    preference :test_mode, :boolean, default: true
+    preference :server, :string, default: 'sandbox.affirm.com'
+
+    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.to_s
+      ).first
+
+      return if _payment.nil?
+
+      if _payment.pending?
+        _payment.void_transaction!
+      elsif _payment.completed? && _payment.can_credit?
+        provider.refund(_payment.credit_allowed.to_money.cents, charge_ari)
+      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,195 @@
+<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.preferences[:test_mode] ? 'cdn1-sandbox.affirm.com' : 'cdn1.affirm.com' %>/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 %>,
+      order_id:             "<%= @order.number %>",
+      discount_code:        "<%= @order.coupon_code %>",
+      shipping_type:        "<%= @order.shipments.first.shipping_method.name if @order.shipments.exists? %>",
+      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 %>",
+        }
+      },
+
+
+      metadata: {
+            "platform_type": "Spree Commerce",
+            "platform_version": "<%= Spree.version %>",
+            "platform_affirm": "<%= Spree::Gateway::Affirm.version %>",
+          },
+
+      meta: {
+        source: {
+          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 %>,
+          }
+        }
+      },
+
+      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.adjustments.promotion.each do |adjustment| %>
+          "<%= adjustment.label %>": {
+            discount_amount:       <%= (0-adjustment.amount*100).to_i %>,
+            discount_display_name: "<%= adjustment.label %>"
+          },
+        <% 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() {
+
+        /*****************************************************\
+            change the payment method name
+        \*****************************************************/
+
+        $( ".payment-option" ).each(function() {
+          
+          if($( this )[0].innerText === "Affirm"){
+
+           $( this )[0].lastChild.data = "Affirm Monthly Payments";
+          }
+        });
+
+        /*****************************************************\
+            setup loading and cancel events for the form
+        \*****************************************************/
+
+        affirm.checkout.on("cancel", function(){
+          $("#checkout_form_payment input.disabled")
+            .attr("disabled", false)
+            .removeClass("disabled");
+        });
+
+        /*****************************************************\
+            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]);
+
+            // submit the checkout
+            affirm.checkout.open({
+              target: $submit_button
+            });
+
+            e.preventDefault();
+            return false;
+          }
+        });
+      });
+
+      /*****************************************************\
+          remove the payment source empty box from UI
+      \*****************************************************/
+      $(document).on('click', '#checkout_form_payment'
+        , function (event) {
+          if($('div[data-hook="checkout_payment_step"] input[type="radio"]:checked')[0].parentNode.outerText === "Affirm Monthly Payments") $('.payment-sources').hide();
+        }
+      )
+    });
+
+    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 %>"
+  };
+}());
+
+</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,29 @@
+# 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"
+        "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"
+

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