spree_paypal_api_checkout 0.1.0 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53c335900fbbe782e6fc7cfa78b36f258b514a9d9b9400cef65f7fb8c7cf69c7
-  data.tar.gz: 946f4fa867ded14d6c7f494df8d8e21377721b682df09fe7cffd312540268540
+  metadata.gz: b79612956a0c2a85e4e971f5967be818be56d438b7034f7cc7b7bef83a01178d
+  data.tar.gz: f0ef4e1ea934c9c0309401707474219acb71a99a7471ec59a0da91eb29749eae
 SHA512:
-  metadata.gz: 0d1754cdff574bb9bbe6b798663c02686228ec3a0e7fe30281b87dea2264245d2f296e849ad44145282305766678b5956834a8a44f0ed17c38e6a644abeb0719
-  data.tar.gz: aef76e65dae6694919ddc17f3c290de2a49be957ac913a9a0ba4863bfe0f1a576d7a10c7e7fcce1a658e087c1b48786514f21c329354094024a124b961986801
+  metadata.gz: a3a8b3c4673d8ce405272ee20010636c0d3ded18eccf5c446cb2ad3a4f386bd5fa696e1f9d5783de6dcf12f0ce684668c9f62f7f36d07fce46fbb7a9678bb5f8
+  data.tar.gz: 2fb57d527e37a19d25b92a2e9f97f7f5143294e77b12f5b369d19e96a0b5670fc6dff7e11a30f1b03af9714e4ae6726bc393cec629f681c0aa5a3b6db5af782e

data/README.md

@@ -4,7 +4,7 @@
 
 1. Add this extension to your Gemfile with this line:
         
-        gem 'spree_paypal_api_checkout', '~> 0.1.0'
+        gem 'spree_paypal_api_checkout', '~> 0.1.3'
 
 2. Install the gem using Bundler:
 

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

@@ -3,7 +3,7 @@
 SpreePaypalCheckout = {
   hideSettings: function(paymentMethod) {
     if (SpreePaypalCheckout.paymentMethodID && paymentMethod.val() == SpreePaypalCheckout.paymentMethodID) {
-      $('.payment-method-settings').children().hide();
+      // $('.payment-method-settings').children().hide();
       $('#payment_amount').prop('disabled', 'disabled');
       $('button[type="submit"]').prop('disabled', 'disabled');
       $('#paypal-warning').show();

data/app/controllers/spree/paypal_checkout_controller.rb

@@ -1,6 +1,7 @@
 module Spree
   class PaypalCheckoutController < StoreController
     skip_before_action :verify_authenticity_token
+
     def express
       order = current_order || raise(ActiveRecord::RecordNotFound)
       items = order.line_items.map(&method(:line_item))
@@ -27,22 +28,17 @@ module Spree
         }
       end
 
-      pp_response = provider.create_order(order, express_checkout_request_details(order: order, items: items, tax_adjustments: tax_adjustments, promotion_adjustments: promotion_adjustments))
+      details = express_checkout_request_details(order: order, items: items, tax_adjustments: tax_adjustments, promotion_adjustments: promotion_adjustments)
+      pp_response = provider.parse_response(provider.create_order(order, details))
 
       render json: pp_response
     end
 
     def confirm
       order = current_order || raise(ActiveRecord::RecordNotFound)
-      response = provider.capture_payment(params[:number])
-      order.payments.create!({
-        source: Spree::PaypalApiCheckout.create({
-          token: response['id'],
-          payer_id: response['payer']['payer_id']
-        }),
-        amount: order.total,
-        payment_method: payment_method
-      })
+
+      response = provider.set_payment_records(order, params[:number], payment_method)
+
       render json: response
     end
 
@@ -88,6 +84,7 @@ module Spree
         intent: 'CAPTURE',
         purchase_units: [
           {
+            invoice_id: current_order.number,
             amount: {
               currency_code: current_order.currency,
               value: order.total,

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

@@ -21,38 +21,24 @@ module Spree
     end
 
     def generate_access_token
-      uri = URI.parse("https://#{preferred_server}/v1/oauth2/token")
-      request = Net::HTTP::Post.new(uri)
-      request.basic_auth("#{preferred_api_key}", "#{preferred_secret_key}")
-      request.content_type = 'application/json'
-      request.body = 'grant_type=client_credentials'
-
-      req_options = { use_ssl: uri.scheme == 'https' }
-
-      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
-        response = http.request(request)
-      end
-      return JSON.parse(response.read_body)['access_token']
+      response = post_response_without_token(api_url('v1/oauth2/token'))
+      return response['access_token']
     end
 
     def generate_client_token
-      uri = URI.parse("https://#{preferred_server}/v1/identity/generate-token")
-      return post_response(uri)
+      post_response(api_url('v1/identity/generate-token'))
     end
 
     def create_order order, body
-      uri = URI.parse("https://#{preferred_server}/v2/checkout/orders")
-      return post_response(uri, body)
+      post_response(api_url('v2/checkout/orders'), body)
     end
 
     def capture_payment order_id
-      uri = URI.parse("https://#{preferred_server}/v2/checkout/orders/#{order_id}/capture")
-      return post_response(uri)
+      post_response(api_url("v2/checkout/orders/#{order_id}/capture"))
     end
 
     def refund_payment id, body
-      uri = URI.parse("https://#{preferred_server}/v2/payments/captures/#{id}/refund")
-      return post_response(uri, body)
+      post_response(api_url("v2/payments/captures/#{id}/refund"), body)
     end
 
     def purchase(amount, express_checkout, gateway_options={})
@@ -78,8 +64,10 @@ module Spree
         refund_type: refund_type,
         refund_source: 'any'
       }
-      refund_transaction_response = refund_payment(payment.source.transaction_id, refund_transaction)
-      if refund_transaction_response['status']=='COMPLETED'
+      refund_entry = refund_payment(payment.source.transaction_id, refund_transaction)
+      refund_transaction_response = parse_response(refund_entry)
+
+      if success_response?(refund_transaction_response)
         payment.source.update({
           :refunded_at => Time.now,
           :refund_transaction_id => refund_transaction_response['id'],
@@ -87,7 +75,7 @@ module Spree
           :refund_type => refund_type
         })
 
-        payment.class.create!(
+        refund_payment = payment.class.create!(
           :order => payment.order,
           :source => payment,
           :payment_method => payment.payment_method,
@@ -95,6 +83,7 @@ module Spree
           :response_code => refund_transaction_response['id'],
           :state => 'completed'
         )
+        refund_payment.log_entries.create!(details: refund_entry.to_yaml)
       end
       refund_transaction_response
     end
@@ -102,14 +91,84 @@ module Spree
     def post_response uri, body={}
       request = Net::HTTP::Post.new(uri)
       request['Authorization'] = "Bearer #{generate_access_token}"
+      request.body = body.to_json if body.present?
+
+      return hit_api(request: request, body: body, uri: uri)
+    end
+
+    def post_response_without_token uri, body={}
+      request = Net::HTTP::Post.new(uri)
+      request.basic_auth("#{preferred_api_key}", "#{preferred_secret_key}")
+      request.body = 'grant_type=client_credentials'
+
+      return parse_response(hit_api(request: request, body: body, uri: uri))
+    end
+
+    def hit_api request:, body:, uri:
       request.content_type = 'application/json'
       req_options = { use_ssl: uri.scheme == 'https' }
 
-      request.body = body.to_json if body.present?
       response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
         response = http.request(request)
       end
-      return JSON.parse(response.read_body)
+      response
+    end
+
+    def parse_response response
+      JSON.parse(response.read_body) rescue response
+    end
+
+    def api_url url
+      URI.parse("https://#{preferred_server}/#{url}")
+    end
+
+    def set_payment_records order, number, payment_method
+      raw_response = response = nil
+      success = false
+      begin
+        payment_entry = capture_payment(number)
+        response = parse_response(payment_entry)
+        success = success_response?(response)
+
+        payment = order.payments.create!({
+          source: Spree::PaypalApiCheckout.create({
+            token: response['id'],
+            payer_id: response['payer']['payer_id']
+          }),
+          amount: order.total,
+          payment_method: payment_method
+        })
+      rescue Exception => e
+        raw_response = e.response.body
+        response = response_error(raw_response)
+      rescue JSON::ParserError
+        response = json_error(raw_response)
+      end
+
+      payment.log_entries.create!(details: payment_entry.to_yaml)
+      response
+    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 team if you continue to receive this message.'
+      msg += "  (The raw response returned by the API was #{raw_response.inspect})"
+      {
+        "error" => {
+          "message" => msg
+        }
+      }
+    end
+
+    def success_response? response
+      response.key?('status') && response.key?('id') && (response['status'] == 'COMPLETED')
     end
   end
 end

data/app/models/spree/log_entry_decorator.rb

@@ -0,0 +1,22 @@
+module Spree
+  module LogEntryDecorator
+    def parsed_details
+      @details ||= YAML.safe_load(details, [ActiveMerchant::Billing::Response, Net::HTTPCreated, URI::HTTPS, URI::RFC3986_Parser, Symbol, Regexp, Object])
+    end
+
+    def success_parsed_details?
+      if parsed_details.is_a?(Net::HTTPCreated)
+        parsed_paypal_entry == 'COMPLETED'
+      elsif parsed_details.is_a?(ActiveMerchant::Billing::Response)
+        parsed_details.success?
+      else
+        true
+      end
+    end
+
+    def parsed_paypal_entry
+      JSON.parse(parsed_details.read_body)['status'] rescue parsed_details.to_json
+    end
+  end
+end
+::Spree::LogEntry.prepend(Spree::LogEntryDecorator)

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

@@ -0,0 +1,8 @@
+<% currency = ::Money::Currency.new(entry.source.currency) %>
+<tr>
+  <td><b><%= Spree.t('paypal.status').capitalize %></b></td>
+  <td><%= entry.source.amount.negative? ? entry.source.source.source.state : entry.source.state %></td>
+  <td><%= entry.parsed_paypal_entry %></td>
+  <td><%= currency.symbol %><%= entry.source.amount %></td>
+  <td><%= entry.source.response_code %></td>
+</tr>

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

@@ -0,0 +1,27 @@
+<%= 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 %>
+  <%= button_link_to Spree.t(:logs), spree.admin_order_payment_log_entries_url(@order, @payment), icon: 'file.svg' %>
+<% end %>
+
+<table class='table table-striped' id='listing_log_entries'>
+  <% @log_entries.each do |entry| %>
+    <thead>
+      <tr class="log_entry <%= entry.success_parsed_details? ? 'success' : 'fail' %>">
+        <td colspan='2'>
+          <i class='icon icon-<%= entry.success_parsed_details? ? 'ok-circle' : 'remove-sign' %>'></i> <%= pretty_time(entry.created_at) %>
+        </td>
+      </tr>
+    </thead>
+    <tbody>
+      <%= render "spree/admin/log_entries/#{@payment.payment_method.method_type.gsub(' ', '').underscore}", entry: entry %>
+    </tbody>
+  <% end %>
+</table>

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

@@ -1,4 +1,4 @@
-<div id='paypal-warning' style="display:none">
+<div id='paypal-warning'>
   <strong><%= Spree.t('no_payment_via_admin_backend', :scope => 'paypal') %></strong>
 </div>
 <script>

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

@@ -1,5 +1,5 @@
 <div id="paypal-button-container" class="paypal-button-container"></div>
-<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
+<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.9.1/jquery.min.js"></script>
 <script type="text/javascript" src="https://www.paypal.com/sdk/js?client-id=<%= payment_method.preferred_api_key %>&currency=<%= @order.currency %>"></script>
 
 <script type="text/javascript">

data/config/locales/de.yml

@@ -15,6 +15,7 @@ de:
       refund_unsuccessful: "PayPal Erstattung nicht erfolgreich"
       actions:
         refund: "Erstatten"
+      status: 'Toestand'
       flash:
         cancel: "Sie wollen PayPal doch nicht benutzen? Kein Problem."
         connection_failed: "Verbindung zu Paypal nicht erfolgreich."

data/config/locales/en.yml

@@ -15,6 +15,7 @@ en:
       refund_unsuccessful: "PayPal refund unsuccessful"
       actions:
         refund: "Refund"
+      status: Status
       flash:
         cancel: "Don't want to use PayPal? No problems."
         connection_failed: "Could not connect to PayPal."

data/config/locales/es.yml

@@ -15,6 +15,7 @@ es:
       refund_unsuccessful: "No se pudo rembolsar el pago de PayPal"
       actions:
         refund: "Reembolso"
+      status: Estado
       flash:
         cancel: "No quieres usar PayPal? No hay problema."
         connection_failed: "No se pudo conectar con PayPal."

data/config/locales/it.yml

@@ -15,6 +15,7 @@ it:
       refund_unsuccessful: "Rimborso PayPal non completato"
       actions:
         refund: "Rimborso"
+      status: Stato
       flash:
         cancel: "Non vuoi usare PayPal? Nessun problema."
         connection_failed: "Impossibile connettersi a PayPal."

data/config/locales/pl.yml

@@ -15,6 +15,7 @@ pl:
       refund_unsuccessful: "Błąd podczas wykonywania zwrotu PayPal"
       actions:
         refund: "Zwróć Płatność"
+      status: Status
       flash:
         cancel: "Nie chcesz użyć PayPal? Nie ma problemu."
         connection_failed: "Nie można było połączyć się z usługą PayPal."

data/config/locales/pt.yml

@@ -15,6 +15,7 @@ pt:
       refund_unsuccessful: "Não foi possível reembolsar o pagamento de PayPal"
       actions:
         refund: "Reembolso"
+      status: Status
       flash:
         cancel: "Não pretende usar PayPal? Não há problema."
         connection_failed: "Não foi possível estabelecer ligação com o PayPal."

data/lib/spree_paypal_api_checkout/version.rb

@@ -1,3 +1,3 @@
 module SpreePaypalApiCheckout
-  VERSION = '0.1.0'
+  VERSION = '0.1.3'
 end

data/spree_paypal_api_checkout.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "spree_paypal_api_checkout".freeze
-  s.version = "0.1.0"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -8,7 +8,7 @@ Gem::Specification.new do |s|
   s.date = "2022-02-22"
   s.description = "Adds PayPal API Checkout as a Payment Method to Spree Commerce".freeze
   s.email = "gems@spreecommerce.com".freeze
-  s.files = [".gitignore".freeze, "Gemfile".freeze, "README.md".freeze, "Rakefile".freeze, "app/assets/javascripts/spree/backend/spree_paypal_checkout.js".freeze, "app/assets/javascripts/spree/frontend/spree_paypal_checkout.js".freeze, "app/assets/stylesheets/spree/backend/spree_paypal_checkout.css".freeze, "app/assets/stylesheets/spree/frontend/spree_paypal_checkout.css".freeze, "app/controllers/spree/admin/payments_controller_decorator.rb".freeze, "app/controllers/spree/admin/paypal_checkout_payments_controller.rb".freeze, "app/controllers/spree/paypal_checkout_controller.rb".freeze, "app/models/spree/gateway/pay_pal_checkout.rb".freeze, "app/models/spree/paypal_api_checkout.rb".freeze, "app/views/spree/admin/payments/_paypal_checkout_complete.html.erb".freeze, "app/views/spree/admin/payments/paypal_checkout_refund.html.erb".freeze, "app/views/spree/admin/payments/source_forms/_paypal_checkout.html.erb".freeze, "app/views/spree/admin/payments/source_views/_paypal_checkout.html.erb".freeze, "app/views/spree/checkout/payment/_paypal_checkout.html.erb".freeze, "config/locales/de.yml".freeze, "config/locales/en.yml".freeze, "config/locales/es.yml".freeze, "config/locales/it.yml".freeze, "config/locales/pl.yml".freeze, "config/locales/pt.yml".freeze, "config/routes.rb".freeze, "db/migrate/20220620042734_create_spree_paypal_api_checkouts.rb".freeze, "lib/generators/spree_paypal_api_checkout/install/install_generator.rb".freeze, "lib/spree_paypal_api_checkout.rb".freeze, "lib/spree_paypal_api_checkout/engine.rb".freeze, "lib/spree_paypal_api_checkout/version.rb".freeze, "script/rails".freeze, "spree_paypal_api_checkout.gemspec".freeze]
+  s.files = [".gitignore".freeze, "Gemfile".freeze, "README.md".freeze, "Rakefile".freeze, "app/assets/javascripts/spree/backend/spree_paypal_checkout.js".freeze, "app/assets/javascripts/spree/frontend/spree_paypal_checkout.js".freeze, "app/assets/stylesheets/spree/backend/spree_paypal_checkout.css".freeze, "app/assets/stylesheets/spree/frontend/spree_paypal_checkout.css".freeze, "app/controllers/spree/admin/payments_controller_decorator.rb".freeze, "app/models/spree/log_entry_decorator.rb".freeze, "app/controllers/spree/admin/paypal_checkout_payments_controller.rb".freeze, "app/controllers/spree/paypal_checkout_controller.rb".freeze, "app/models/spree/gateway/pay_pal_checkout.rb".freeze, "app/models/spree/paypal_api_checkout.rb".freeze, "app/views/spree/admin/payments/_paypal_checkout_complete.html.erb".freeze, "app/views/spree/admin/payments/paypal_checkout_refund.html.erb".freeze, "app/views/spree/admin/payments/source_forms/_paypal_checkout.html.erb".freeze, "app/views/spree/admin/payments/source_views/_paypal_checkout.html.erb".freeze, "app/views/spree/checkout/payment/_paypal_checkout.html.erb".freeze, "app/views/spree/admin/log_entries/_paypal_checkout.html.erb".freeze, "app/views/spree/admin/log_entries/index.html.erb".freeze, "config/locales/de.yml".freeze, "config/locales/en.yml".freeze, "config/locales/es.yml".freeze, "config/locales/it.yml".freeze, "config/locales/pl.yml".freeze, "config/locales/pt.yml".freeze, "config/routes.rb".freeze, "db/migrate/20220620042734_create_spree_paypal_api_checkouts.rb".freeze, "lib/generators/spree_paypal_api_checkout/install/install_generator.rb".freeze, "lib/spree_paypal_api_checkout.rb".freeze, "lib/spree_paypal_api_checkout/engine.rb".freeze, "lib/spree_paypal_api_checkout/version.rb".freeze, "script/rails".freeze, "spree_paypal_api_checkout.gemspec".freeze]
   s.homepage = "http://www.spreecommerce.com".freeze
   s.required_ruby_version = Gem::Requirement.new(">= 2.2.2".freeze)
   s.requirements = ["none".freeze]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_paypal_api_checkout
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.3
 platform: ruby
 authors:
 - Spree Commerce
@@ -362,7 +362,10 @@ files:
 - app/controllers/spree/admin/paypal_checkout_payments_controller.rb
 - app/controllers/spree/paypal_checkout_controller.rb
 - app/models/spree/gateway/pay_pal_checkout.rb
+- app/models/spree/log_entry_decorator.rb
 - app/models/spree/paypal_api_checkout.rb
+- app/views/spree/admin/log_entries/_paypal_checkout.html.erb
+- app/views/spree/admin/log_entries/index.html.erb
 - app/views/spree/admin/payments/_paypal_checkout_complete.html.erb
 - app/views/spree/admin/payments/paypal_checkout_refund.html.erb
 - app/views/spree/admin/payments/source_forms/_paypal_checkout.html.erb