spree_paypal_api_checkout 0.0.8 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a5a5201c741e77e835868a6fda79d71b658c1b58fabca8ef39d3990199294f2
-  data.tar.gz: d9b4e0c18fef43f234f07ed9bfc011811fbd87b49751cb524dfba3f189c428df
+  metadata.gz: bd7531190eafee3bb5fe40ac3378269b2e9265e4c66773cf2a447f0c1cef757f
+  data.tar.gz: b62014828506b097f6287cfa41ffde2e4638f29e5be241f9746aa28ea23e4e24
 SHA512:
-  metadata.gz: fb54727dee1cef2a75bdf4527b6ba3c33d2dad98cb14a85ec36099be4c7f3dd9c0ed80918fd4a794330d47055c069113b20fc01fb8b62c0df73cfe2988dc4e33
-  data.tar.gz: 9cf9906841e3359b96fae7f8581dcea5c24026035c7a02e46a7351efc9c1b17d8bb9a3c1f029330b07f7f4f89cb5dae9be5c04d14f034cd2335282e31fabfe45
+  metadata.gz: beaf4e7e206f97393da179553fe15e6548734fffcb62dce78b3b6bdb6dc79d344b83bc8f332900525e586d0575fc0b367cfb21e99781c995d5ec14f07496546d
+  data.tar.gz: da8a449dd52eeb1d1c864b65db9f1bc84e5be991316d7578f90657f1a3eaba7bb384ca9fd21a48165fc997b18b8a09c8fad748e6be4b2b864069d078e3240c2d

data/README.md

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

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))
@@ -8,46 +9,43 @@ module Spree
       additional_adjustments = order.all_adjustments.additional
       tax_adjustments = additional_adjustments.tax
       shipping_adjustments = additional_adjustments.shipping
+      promotion_adjustments = additional_adjustments.promotion
 
       additional_adjustments.eligible.each do |adjustment|
         # 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."
         next if adjustment.amount.zero?
-        next if tax_adjustments.include?(adjustment) || shipping_adjustments.include?(adjustment)
+        next if tax_adjustments.include?(adjustment) || shipping_adjustments.include?(adjustment) || promotion_adjustments.include?(adjustment)
 
         items << {
           name: adjustment.label,
           quantity: 1,
-          amount: {
+          unit_amount: {
             currency_code: order.currency,
             value: adjustment.amount
           }
         }
       end
 
-      pp_response = provider.create_order(order, express_checkout_request_details(order, items))
+      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
 
     def proceed
       order = current_order || raise(ActiveRecord::RecordNotFound)
       order.payments.last.source.update(transaction_id: params[:transaction_id])
+      order.payments.last.update(response_code: params[:transaction_id])
       order.next
       path = checkout_state_path(order.state)
       if order.complete?
@@ -70,31 +68,68 @@ module Spree
     def line_item(item)
       {
           name: item.product.name,
-          number: item.variant.sku,
+          sku: item.variant.sku,
           quantity: item.quantity,
-          amount: {
+          description: item.product.meta_description,
+          unit_amount: {
             currency_code: item.order.currency,
             value: item.price
           },
-          ItemCategory: "Physical"
+          item_category: "Physical"
       }
     end
 
-    def express_checkout_request_details order, items
+    def express_checkout_request_details order:, items:, tax_adjustments:, promotion_adjustments:
       {
         intent: 'CAPTURE',
         purchase_units: [
           {
             amount: {
               currency_code: current_order.currency,
-              value: order.total
+              value: order.total,
+              breakdown: {
+                item_total: {
+                  currency_code: current_order.currency,
+                  value: items.sum{|r| (r[:unit_amount][:value] * r[:quantity]) }
+                },
+                shipping: {
+                  currency_code: current_order.currency,
+                  value: current_order.shipments.sum(:cost)
+                },
+                tax_total: {
+                  currency_code: current_order.currency,
+                  value: tax_adjustments.sum(:amount)
+                },
+                discount: {
+                  currency_code: current_order.currency,
+                  value: promotion_adjustments.sum(:amount).abs
+                }
+              }
             },
-            item: items
+            items: items,
+            shipping: address_options
           },
         ]
       }
     end
 
+    def address_options
+      address = current_order.ship_address
+      {
+        name: { full_name: address.try(:full_name) },
+        address: {
+          address_line_1: address.address1,
+          address_line_2: address.address2,
+          # phone: address.phone,
+          admin_area_1: address.state_text,
+          admin_area_2: address.city,
+          country_code: address.country.iso,
+          postal_code: address.zipcode
+        },
+        type: 'SHIPPING'
+      }
+    end
+
     def payment_method
       Spree::PaymentMethod.find(params[:payment_method_id])
     end

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

@@ -20,75 +20,25 @@ module Spree
       'paypal_checkout'
     end
 
-    def generate_client_token
-      uri = URI.parse("https://#{preferred_server}/v1/identity/generate-token")
-      request = Net::HTTP::Post.new(uri)
-      request['Authorization'] = "Bearer #{generate_access_token}"
-      request.content_type = "application/json"
-
-      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 response
-    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 = post_response_without_token(api_url('v1/oauth2/token'))
+      return response['access_token']
+    end
 
-      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']
+    def generate_client_token
+      post_response(api_url('v1/identity/generate-token'))
     end
 
     def create_order order, body
-      uri = URI.parse("https://#{preferred_server}/v2/checkout/orders")
-      request = Net::HTTP::Post.new(uri)
-      request['Authorization'] = "Bearer #{generate_access_token}"
-      request.content_type = "application/json"
-
-      request.body = body.to_json
-      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)
+      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")
-      request = Net::HTTP::Post.new(uri)
-      request['Authorization'] = "Bearer #{generate_access_token}"
-      request.content_type = "application/json"
-      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)
+      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")
-      request = Net::HTTP::Post.new(uri)
-      request['Authorization'] = "Bearer #{generate_access_token}"
-      request.body = body.to_json
-      request.content_type = "application/json"
-      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)
+      post_response(api_url("v2/payments/captures/#{id}/refund"), body)
     end
 
     def purchase(amount, express_checkout, gateway_options={})
@@ -114,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'],
@@ -123,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,
@@ -131,9 +83,93 @@ 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
+
+    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' }
+
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        response = http.request(request)
+      end
+      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/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.0.8'
+  VERSION = '0.1.1'
 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.0.8"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spree_paypal_api_checkout
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.1
 platform: ruby
 authors:
 - Spree Commerce
@@ -401,7 +401,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - none
-rubygems_version: 3.2.15
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Adds PayPal API Checkout as a Payment Method to Spree Commerce