flowcommerce_spree 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3810faadd82b0d21c0bacaeaa6be61bfe314ddffe4f32a6805c05554c592a745
-  data.tar.gz: 6d042ed69b193082492ac992ea3d4a9bd962e493ae49026a43c297492013b4ea
+  metadata.gz: c3c70c6b82576ce2c4aa02c3b68a34c1c7b17360099ec14b59113d9fe59600d4
+  data.tar.gz: 6350b688c98c72b9c4a63ac4b91e412cf33683739e710c49ea85b3d4e3b6234e
 SHA512:
-  metadata.gz: 6bd6d8e87e8f5d8c5d30d9f4366bc0e6d06dc95504d6f8cd3fc8916c752478123e80671ac5da4063a02c6051eb56d95f14ef97d782249a7fa9cb1df4e983829f
-  data.tar.gz: 260d3b14add605bc114bd561a39f7376a88850d4aea95a98339db5461a9845463a87da1cd845cf68a6b8732a88d7f445a8961fb4f5a0847c282130efeb247083
+  metadata.gz: 651de4bcd8137242f0f6b50d21ccc2971f4b862d8e486f2087b3df19635f62c4ab7d2c00162d7801b27bd17fff8cf16c0df902e3cd3feb84f40513937cd483ba
+  data.tar.gz: c4ebc042ff007ccfc9fed580fd152f7be335eb3f4b899fc858511380a3bc6037bfb2d91ecfb28d9624731a433f49a25f8016a374de02602ad848ae88e27223cc

data/README.md

@@ -20,8 +20,15 @@ All flowcommerce_spree code is located in the ./app and ./lib folders.
 
 - Run `bundle install`.
 
-- Define this additional ENV variables. You will find all of them, except FLOW_MOUNT_PATH in 
-  [Flow console](https://console.flow.io/org_account_name/organization/integrations):
+- Define these additional ENV variables. 
+  - You will find FLOW_TOKEN, FLOW_ORGANIZATION and FLOW_BASE_COUNTRY in [Flow 
+  console](https://console.flow.io/org_account_name/organization/integrations)
+  - To enable HTTP Basic authentication for securing the FlowcommerceSpree::WebhooksController, prepend 
+    username:password@ to the hostname in your webhook URL. 
+    By doing so, the credentials needed for authentication will be sent in the HTTP header.
+    For example: https://username:password@www.mywebhookurl.com
+    On the main app's backend side, the `username` and `password` values should be defined in the 
+    FLOW_IO_WEBHOOK_USER and FLOW_IO_WEBHOOK_PASSWORD environment variables
 
     ```
     FLOW_TOKEN='SUPERsecretTOKEN' # API_KEY
@@ -29,7 +36,10 @@ All flowcommerce_spree code is located in the ./app and ./lib folders.
     FLOW_BASE_COUNTRY='usa'
     # The path to which the FlowcommerceSpree engine will be mounted (default, if this variable is missing, will be the 
     # '/flow' path)
-    FLOW_MOUNT_PATH='/flow' 
+    FLOW_MOUNT_PATH='/flow'
+    # The following variables should be set for securing the FlowcommerceSpree::WebhooksControler
+    FLOW_IO_WEBHOOK_USER
+    FLOW_IO_WEBHOOK_PASSWORD
     ```
 
 - To enable payments with the FlowCommerce engine, the payment method `flow.io` with `Spree::Gateway::FlowIo` should be 
@@ -86,7 +96,9 @@ being used, depending on the level of modification.
 
 ### Spree::Gateway::FlowIo
 
-Adapter for Spree, that allows using [Flow.io](https://www.flow.io) as payment gateway. Flow is PCI compliant payment processor.
+Adapter for Spree, that allows using [Flow.io](https://www.flow.io) as payment gateway. 
+Flow is PCI compliant payment processor.
+
 
 ## Gem Maintenance
 
@@ -129,11 +141,28 @@ by the following command:
 gem build flowcommerce_spree.gemspec
 ```
 
-Asuming the version was set to `0.0.1`, a `flowcommerce_spree-0.0.1.gem` will be generated at the root of the app 
-(repo).
+Assuming the version was set to `0.0.1`, 
+a `flowcommerce_spree-0.0.1.gem` binary file will be generated at the root of the app (repo).
+
+- The binary file shouldn't be added into the `git` tree, it will be pushed into the RubyGems and to the GitHub releases
 
 ### Pushing a new gem release to RubyGems
 
 ```
 gem push flowcommerce_spree-0.0.1.gem # don't forget to specify the correct version number
 ```
+
+### Crafting the new release on GitHub
+
+On the [Releases page](https://github.com/mejuri-inc/flowcommerce_spree/releases) push the `Draft a new release` button.
+
+The new release editing page opens, on which the following actions could be taken:
+
+- Choose the repo branch (default is `main`)
+- Insert a tag version (usually, the tag should correspond to the gem's new version, v0.0.1, for example)
+    - the tag will be created by GitHub on the last commit into the chosen branch
+- Fill the release Title and Description
+- Attach the binary file with the generated gem version
+- If the release is not yet ready for production, mark the `This is a pre-release` checkbox
+- Press either the `Publish release`, or the `Save draft button` if you want to publish it later
+    - After publishing the release, the the binary gem file will be available on GitHub and could be removed locally

data/app/controllers/flowcommerce_spree/webhooks_controller.rb

@@ -4,34 +4,32 @@ module FlowcommerceSpree
   class WebhooksController < ActionController::Base
     wrap_parameters false
     respond_to :json
+    http_basic_authenticate_with name: FLOW_IO_WEBHOOK_USER, password: FLOW_IO_WEBHOOK_PASSWORD
 
-    # forward all incoming requests to Flow WebhookService object
+    # forward incoming requests to respective Flow Webhooks Service objects
     # /flow/event-target endpoint
-    def handle_flow_web_hook_event
-      result = check_organization
-      if result.blank?
-        webhook_result = WebhookService.process(params)
-        result[:error] = webhook_result.full_messages.join("\n") if webhook_result.errors.any?
-      end
+    def handle_flow_io_event
+      %i[event_id organization discriminator].each_with_object(params) { |key, obj| obj.require(key) }
+      return unless organization_valid?
+
+      webhook_result = "FlowcommerceSpree::Webhooks::#{params['discriminator'].classify}".constantize.process(params)
+      @result = {}
+      @result[:error] = webhook_result.full_messages.join("\n") if webhook_result.errors.any?
     rescue StandardError => e
-      result = { error: e.class.to_s, message: e.message, backtrace: e.backtrace }
+      @result = { error: e.class.to_s, message: e.message, backtrace: e.backtrace }
     ensure
-      response_status = if result[:error]
-                          logger.info(result)
-                          :unprocessable_entity
-                        else
-                          :ok
-                        end
-      render json: result.except(:backtrace), status: response_status
+      logger.info(@result) if (error = @result[:error])
+      render json: @result.except(:backtrace), status: error ? :unprocessable_entity : :ok
     end
 
     private
 
-    def check_organization
+    def organization_valid?
       org = params[:organization]
-      return {} if org == FlowcommerceSpree::ORGANIZATION
+      return true if org == FlowcommerceSpree::ORGANIZATION
 
-      { error: 'InvalidParam', message: "Organization '#{org}' is invalid!" }
+      @result = { error: 'InvalidParam', message: "Organization '#{org}' is invalid!" }
+      false
     end
   end
 end

data/app/models/spree/app_configuration_decorator.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Spree
+  AppConfiguration.class_eval do
+    preference :debug_request_ip_address, :string
+  end
+end

data/app/models/spree/calculator/shipping/flow_io.rb

@@ -4,6 +4,9 @@ module Spree
   class Calculator
     module Shipping
       class FlowIo < ShippingCalculator
+        preference :lower_boundary, :decimal, default: 100
+        preference :charge_default, :decimal, default: 15
+
         def self.description
           'FlowIO Calculator'
         end
@@ -16,11 +19,11 @@ module Spree
         end
 
         def default_charge(_country)
-          0
+          preferred_charge_default
         end
 
         def threshold
-          0
+          preferred_lower_boundary
         end
 
         private

data/app/models/spree/flow_io_order_decorator.rb

@@ -23,6 +23,12 @@ module Spree
       flow_data&.[]('order')
     end
 
+    def flow_order_with_payments?
+      payment = payments.completed.first
+
+      payment&.payment_method&.type == 'Spree::Gateway::FlowIo'
+    end
+
     # accepts line item, usually called from views
     def flow_line_item_price(line_item, total = false)
       result = if (order = flow_order)
@@ -42,56 +48,9 @@ module Spree
       result
     end
 
-    # prepares array of prices that can be easily renderd in templates
-    def flow_cart_breakdown
-      prices = []
-
-      price_model = Struct.new(:name, :label)
-
-      if flow_order
-        # duty, vat, ...
-        unless flow_order.prices
-          message = Flow::Error.format_order_message flow_order
-          raise Flow::Error, message
-        end
-
-        flow_order.prices.each do |price|
-          prices.push price_model.new(price['name'], price['label'])
-        end
-      else
-        price_elements =
-          %i[item_total adjustment_total included_tax_total additional_tax_total tax_total shipment_total promo_total]
-        price_elements.each do |el|
-          price = send(el)
-          if price > 0
-            label = FlowcommerceSpree::Api.format_default_price price
-            prices.push price_model.new(el.to_s.humanize.capitalize, label)
-          end
-        end
-
-        # discount is applied and we allways show it in default currency
-        if adjustment_total != 0
-          formated_discounted_price = FlowcommerceSpree::Api.format_default_price adjustment_total
-          prices.push price_model.new('Discount', formated_discounted_price)
-        end
-      end
-
-      # total
-      prices.push price_model.new(Spree.t(:total), flow_total)
-
-      prices
-    end
-
     # shows localized total, if possible. if not, fall back to Spree default
     def flow_io_total_amount
-      flow_data&.dig('order', 'total', 'amount')&.to_d
-    end
-
-    def flow_experience
-      model = Struct.new(:key)
-      model.new flow_order.experience.key
-    rescue StandardError => _e
-      model.new ENV.fetch('FLOW_BASE_COUNTRY')
+      flow_data&.dig('order', 'total', 'amount')&.to_d || 0
     end
 
     def flow_io_experience_key
@@ -135,27 +94,21 @@ module Spree
       flow_data&.[]('captures')&.each do |c|
         next if c['status'] != 'succeeded'
 
-        captures_sum += c['amount']
+        amount = c['amount']
+        amount = amount.to_d if amount.is_a?(String)
+        captures_sum += amount
       end
       captures_sum.to_d
     end
 
     def flow_io_balance_amount
-      flow_data&.dig('order', 'balance', 'amount')&.to_d
+      flow_data&.dig('order', 'balance', 'amount')&.to_d || 0
     end
 
     def flow_io_payments
       flow_data.dig('order', 'payments')
     end
 
-    def flow_payment_method
-      if flow_data['payment_type'] == 'paypal'
-        'paypal'
-      else
-        'cc' # creait card is default
-      end
-    end
-
     def flow_customer_email
       flow_data.dig('order', 'customer', 'email')
     end

data/app/models/spree/flow_io_variant_decorator.rb

@@ -58,6 +58,8 @@ module Spree
 
       return { error: 'Price is 0' } if price == 0
 
+      return unless country_of_origin
+
       additional_attrs = {}
       attr_name = nil
       export_required = false

data/app/overrides/spree/admin/order_sidebar_summary_flow_link.rb

@@ -0,0 +1,13 @@
+Deface::Override.new(
+  virtual_path: 'spree/admin/shared/_order_tabs',
+  name: 'spree_admin_order_additional_information_flow_message',
+  insert_top: '.additional-info',
+  text: '
+    <% if FlowcommerceSpree::ORGANIZATION.present? && @order.flow_order.present? %>
+      <div style="text-align: center">
+        <%= link_to "See Flow Order",
+                    "https://console.flow.io/#{FlowcommerceSpree::ORGANIZATION}/orders/#{@order.number}",
+                    target: "_blank", class: "button" %>
+      </div>
+    <% end %>'
+)

data/app/overrides/spree/admin/products/order_price_flow_message.rb

@@ -0,0 +1,9 @@
+Deface::Override.new(
+  virtual_path: 'spree/admin/prices/index',
+  name: 'spree_admin_prices_flow_mesage',
+  insert_top: '.no-border-top',
+  text: "
+  <div class='spree-admin-info' >
+    To check localized pricing, please click <a href='#{"https://console.flow.io/#{ENV['FLOW_ORGANIZATION']}/price-books"}' target='_blank'>here</a>.
+  </div>"
+)

data/app/services/flowcommerce_spree/order_sync.rb

@@ -2,58 +2,40 @@
 
 module FlowcommerceSpree
   # represents flow.io order syncing service
-  # for easy integration we are currently passing:
-  # - flow experience
-  # - spree order
-  # - current customer, if present as  @order.user
-  #
-  # example:
-  #  flow_order = FlowcommerceSpree::OrderSync.new    # init flow-order object
-  #    order: Spree::Order.last,
-  #    experience: @flow_session.experience
-  #    customer: @order.user
-  #  flow_order.build_flow_request           # builds json body to be posted to flow.io api
-  #  flow_order.synchronize!                 # sends order to flow
-  class OrderSync # rubocop:disable Metrics/ClassLength
+  class OrderSync
     FLOW_CENTER = 'default'
 
     attr_reader :order, :response
 
-    delegate :url_helpers, to: 'Rails.application.routes'
-
+    # @param [Object] order
+    # @param [String] flow_session_id
     def initialize(order:, flow_session_id:)
-      raise(ArgumentError, 'Experience not defined or not active') unless order.zone&.flow_io_active_experience?
+      raise(ArgumentError, 'Experience not defined or not active') unless order&.zone&.flow_io_active_experience?
 
       @experience = order.flow_io_experience_key
       @flow_session_id = flow_session_id
       @order = order
-      @client = FlowcommerceSpree.client(session_id: flow_session_id)
+      @client = FlowcommerceSpree.client(default_headers: { "Authorization": "Session #{flow_session_id}" },
+                                         authorization: nil)
     end
 
     # helper method to send complete order from Spree to flow.io
     def synchronize!
-      return unless @order.zone&.flow_io_active_experience? && @order.state == 'cart' && @order.line_items.size > 0
+      return unless @order.state == 'cart' && @order.line_items.size > 0
 
       sync_body!
-      write_response_in_cache
+      write_response_to_order
 
       @order.update_columns(total: @order.total, meta: @order.meta.to_json)
       refresh_checkout_token
-      @checkout_token
-    end
-
-    def error
-      @response['messages'].join(', ')
-    end
-
-    def error_code
-      @response['code']
     end
 
     def error?
       @response&.[]('code') && @response&.[]('messages') ? true : false
     end
 
+    private
+
     # builds object that can be sent to api.flow.io to sync order data
     def build_flow_request
       @opts = { experience: @experience, expand: ['experience'] }
@@ -71,24 +53,21 @@ module FlowcommerceSpree
       @body[:discount] = { amount: @order.adjustment_total, currency: @order.currency } if @order.adjustment_total != 0
     end
 
-    private
-
     def refresh_checkout_token
-      root_url = url_helpers.root_url
+      root_url = Rails.application.routes.url_helpers.root_url
       order_number = @order.number
       confirmation_url = "#{root_url}flow/order-completed?order=#{order_number}&t=#{@order.guest_token}"
-      @checkout_token = FlowcommerceSpree.client.checkout_tokens.post_checkout_and_tokens_by_organization(
-        FlowcommerceSpree::ORGANIZATION,
-        discriminator: 'checkout_token_reference_form',
-        order_number: order_number,
-        session_id: @flow_session_id,
-        urls: { continue_shopping: root_url,
-                confirmation: confirmation_url,
-                invalid_checkout: root_url }
-      )&.id
-
       @order.flow_io_attribute_add('flow_return_url', confirmation_url)
       @order.flow_io_attribute_add('checkout_continue_shopping_url', root_url)
+
+      FlowcommerceSpree.client.checkout_tokens.post_checkout_and_tokens_by_organization(
+        FlowcommerceSpree::ORGANIZATION, discriminator: 'checkout_token_reference_form',
+                                         order_number: order_number,
+                                         session_id: @flow_session_id,
+                                         urls: { continue_shopping: root_url,
+                                                 confirmation: confirmation_url,
+                                                 invalid_checkout: root_url }
+      )&.id
     end
 
     # if customer is defined, add customer info
@@ -100,13 +79,14 @@ module FlowcommerceSpree
       customer_ship_address = customer.ship_address
       address = customer_ship_address if customer_ship_address&.country&.iso3 == @order.zone.flow_io_experience_country
 
+      customer_profile = customer.user_profile
       unless address
-        user_profile_address = customer.user_profile&.address
+        user_profile_address = customer_profile&.address
         address = user_profile_address if user_profile_address&.country&.iso3 == @order.zone.flow_io_experience_country
       end
 
-      @body[:customer] = { name: { first: address&.firstname,
-                                   last: address&.lastname },
+      @body[:customer] = { name: { first: address&.firstname || customer_profile&.first_name,
+                                   last: address&.lastname || customer_profile&.last_name },
                            email: customer.email,
                            number: customer.flow_number,
                            phone: address&.phone }
@@ -116,14 +96,14 @@ module FlowcommerceSpree
 
     def add_customer_address(address)
       streets = []
-      streets.push address.address1 if address&.address1.present?
-      streets.push address.address2 if address&.address2.present?
+      streets.push address.address1 if address.address1.present?
+      streets.push address.address2 if address.address2.present?
 
       @body[:destination] = { streets: streets,
-                              city: address&.city,
-                              province: address&.state_name,
-                              postal: address&.zipcode,
-                              country: (address&.country&.iso3 || ''),
+                              city: address.city,
+                              province: address.state_name,
+                              postal: address.zipcode,
+                              country: (address.country&.iso3 || ''),
                               contact: @body[:customer] }
 
       @body[:destination].delete_if { |_k, v| v.nil? }
@@ -132,20 +112,8 @@ module FlowcommerceSpree
     def sync_body!
       build_flow_request
 
-      @use_get = false
-
-      # use get if order is completed and closed
-      @use_get = true if @order.flow_data.dig('order', 'submitted_at').present? || @order.state == 'complete'
-
-      # do not use get if there is no local order cache
-      @use_get = false unless @order.flow_data['order']
-
-      if @use_get
-        @response ||= @client.orders.get_by_number(ORGANIZATION, @order.number).to_hash
-      else
-        @response = @client.orders.put_by_number(ORGANIZATION, @order.number,
-                                                 Io::Flow::V0::Models::OrderPutForm.new(@body), @opts).to_hash
-      end
+      @response = @client.orders.put_by_number(ORGANIZATION, @order.number,
+                                               Io::Flow::V0::Models::OrderPutForm.new(@body), @opts).to_hash
     end
 
     def add_item(line_item)
@@ -160,23 +128,12 @@ module FlowcommerceSpree
                  currency: price_root['currency'] || variant.cost_currency } }
     end
 
-    # set cache for total order amount
-    # written in flow_data field inside spree_orders table
-    def write_response_in_cache
-      if !@response || error?
-        @order.flow_data.delete('order')
-      else
-        response_total = @response[:total]
-        response_total_label = response_total&.[](:label)
-        cache_total = @order.flow_data.dig('order', 'total', 'label')
-
-        # return if total is not changed, no products removed or added
-        return if @use_get && response_total_label == cache_total
-
-        # update local order
-        @order.total = response_total&.[](:amount)
-        @order.flow_data.merge!('order' => @response)
-      end
+    def write_response_to_order
+      return @order.flow_data.delete('order') if !@response || error?
+
+      # update local order
+      @order.total = @response[:total]&.[](:amount)
+      @order.flow_data.merge!('order' => @response)
     end
   end
 end