flowcommerce_spree 0.0.4 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3810faadd82b0d21c0bacaeaa6be61bfe314ddffe4f32a6805c05554c592a745
-  data.tar.gz: 6d042ed69b193082492ac992ea3d4a9bd962e493ae49026a43c297492013b4ea
+  metadata.gz: f47f9a9debf77ea1ca7d10d8a2661a4abac350f3602b98a50686919476038187
+  data.tar.gz: '04964f886f5dab774f4e1631a5ab9c0bda612e35599ad4c639dc7dcee8d7396b'
 SHA512:
-  metadata.gz: 6bd6d8e87e8f5d8c5d30d9f4366bc0e6d06dc95504d6f8cd3fc8916c752478123e80671ac5da4063a02c6051eb56d95f14ef97d782249a7fa9cb1df4e983829f
-  data.tar.gz: 260d3b14add605bc114bd561a39f7376a88850d4aea95a98339db5461a9845463a87da1cd845cf68a6b8732a88d7f445a8961fb4f5a0847c282130efeb247083
+  metadata.gz: fc5929eff62c6c11b58eed26b580d0cc34c3c51e5a4a81869773a115e5210ac9808e740fb00112de84f5fcc6afc63db404bd97960398bf09d021d588f2624520
+  data.tar.gz: 9311543f7e2b18e55326f1826d7240b6315efed2ac7f81c94c60d4c8236f5d4e5381cbb5e7e956880723d76384cf89b23e8306ac8026c14af36ad16344b8bd56

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/concerns/current_zone_loader_decorator.rb

@@ -7,12 +7,14 @@ CurrentZoneLoader.module_eval do
     return @current_zone if defined?(@current_zone)
 
     @current_zone = if (session_region_name = session['region']&.[]('name'))
-                      Spree::Zones::Product.find_by(name: session_region_name)
-                    elsif request_iso_code.present?
-                      @current_zone = flow_zone
-                      @current_zone ||= Spree::Country.find_by(iso: request_iso_code)&.product_zones&.active&.first
+                      Spree::Zones::Product.find_by(name: session_region_name, status: 'active')
                     end
 
+    @current_zone ||= if request_iso_code.present?
+                        @current_zone = flow_zone
+                        @current_zone ||= Spree::Country.find_by(iso: request_iso_code)&.product_zones&.active&.first
+                      end
+
     @current_zone ||= Spree::Zones::Product.find_by(name: 'International') ||
                       Spree::Zones::Product.new(name: 'International', taxon_ids: [], currencies: %w[USD CAD])
 
@@ -29,16 +31,9 @@ CurrentZoneLoader.module_eval do
                                        .where("meta -> 'flow_data' ->> 'country' = ?",
                                               ISO3166::Country[request_iso_code]&.alpha3).exists?
 
-    request_ip = if Rails.env.production?
-                   request.ip
-                 else
-                   Spree::Config[:debug_request_ip_address] || request.ip
-                   # Germany ip: 85.214.132.117, Sweden ip: 62.20.0.196, Moldova ip: 89.41.76.29
-                 end
-
     # This will issue a session creation request to flow.io. The response will contain the Flow Experience key and
     # the session_id
-    flow_io_session = FlowcommerceSpree::Session.create(ip: request_ip, visitor: visitor_id_for_flow_io)
+    flow_io_session = FlowcommerceSpree::Session.create(country: request_iso_code, visitor: visitor_id_for_flow_io)
 
     if (zone = Spree::Zones::Product.active.find_by(name: flow_io_session.experience&.key&.titleize))
       session['flow_session_id'] = flow_io_session.id

data/app/controllers/flowcommerce_spree/orders_controller.rb

@@ -9,7 +9,9 @@ module FlowcommerceSpree
     # proxy enpoint between flow and thankyou page.
     # /flow/order_completed endpoint
     def order_completed
-      flow_updater = FlowcommerceSpree::OrderUpdater.new(order: current_order)
+      order = Spree::Order.find_by number: params[:order], guest_token: params[:t]
+
+      flow_updater = FlowcommerceSpree::OrderUpdater.new(order: order)
       flow_updater.complete_checkout
 
       redirect_to "/thankyou?order=#{params[:order]}&t=#{params[:t]}"

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/flowcommerce_spree/settings.rb

@@ -4,5 +4,6 @@ module FlowcommerceSpree
   class Settings < Spree::Preferences::Configuration
     preference :additional_attributes, :hash, default: {}
     preference :product_catalog_upload, :hash, default: {}
+    preference :notification_setting, :hash, default: {}
   end
 end

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

@@ -11,8 +11,8 @@ module Spree
         order = item.order
 
         if can_calculate_tax?(order)
-          flow_response = get_flow_tax_data(order)
-          tax_for_item(item, flow_response)
+          get_flow_tax_data(order)
+          tax_for_item(item)
         else
           prev_tax_amount(item)
         end
@@ -20,6 +20,13 @@ module Spree
       alias compute_shipment compute_shipment_or_line_item
       alias compute_line_item compute_shipment_or_line_item
 
+      def get_tax_rate(taxable)
+        order = taxable.class.to_s == 'Spree::Order' ? taxable : taxable.order
+        get_flow_tax_data(order) if order.flow_allocations.empty?
+        response = order.flow_tax_for_item(taxable.adjustable, 'vat_item_price', rate.included_in_price)
+        response.nil? ? 0 : response['rate']&.to_f
+      end
+
       private
 
       def prev_tax_amount(item)
@@ -39,21 +46,26 @@ module Spree
 
       def get_flow_tax_data(order)
         flow_io_tax_response = Rails.cache.fetch(order.flow_tax_cache_key, time_to_idle: 5.minutes) do
-          FlowcommerceSpree.client.orders.get_allocations_by_number(FlowcommerceSpree::ORGANIZATION, order.number)
+          response = FlowcommerceSpree.client.orders
+                                      .get_allocations_by_number(FlowcommerceSpree::ORGANIZATION, order.number)
+          return nil unless response.present?
+
+          order.flow_order['allocations'] = response.to_hash
+          order.update_column(:meta, order.meta.to_json)
+          response
         end
         flow_io_tax_response
       end
 
-      def tax_for_item(item, flow_response)
+      def tax_for_item(item)
+        order = item.order
         prev_tax_amount = prev_tax_amount(item)
-        return prev_tax_amount if flow_response.nil?
-
-        item_details = flow_response.details&.find do |el|
-          item.is_a?(Spree::LineItem) ? el.number == item.variant.sku : el.key.value == 'shipping'
-        end
-        price_components = rate.included_in_price ? item_details.included : item_details.not_included
+        tax_data = order.flow_tax_for_item(item, 'vat_item_price', rate.included_in_price)
+        return prev_tax_amount if tax_data.blank?
 
-        amount = price_components&.find { |el| el.key.value == 'vat_item_price' }&.total&.amount
+        subsidy_data = order.flow_tax_for_item(item, 'vat_subsidy', rate.included_in_price)
+        amount = tax_data.dig('total', 'amount')
+        amount += subsidy_data.dig('total', 'amount') if subsidy_data.present?
         amount.present? && amount > 0 ? amount : prev_tax_amount
       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
@@ -205,6 +158,24 @@ module Spree
       address_attributes
     end
 
+    def flow_allocations
+      return @flow_allocations if @flow_allocations
+
+      @flow_allocations = flow_order&.[]('allocations')
+    end
+
+    def flow_tax_for_item(item, tax_key, included_in_price = true)
+      return {} if flow_allocations.blank?
+
+      item_details = flow_allocations['details']&.find do |el|
+        item.is_a?(Spree::LineItem) ? el['number'] == item.variant.sku : el['key'] == 'shipping'
+      end
+      return {} if item_details.blank?
+
+      price_components = included_in_price ? item_details['included'] : item_details['not_included']
+      price_components&.find { |el| el['key'] == tax_key }
+    end
+
     Spree::Order.include(self) if Spree::Order.included_modules.exclude?(self)
   end
 end

data/app/models/spree/flow_io_product_decorator.rb

@@ -7,6 +7,7 @@ module Spree
       base.serialize :meta, ActiveRecord::Coders::JSON.new(symbolize_keys: true)
 
       base.store_accessor :meta, :flow_data, :zone_ids
+      base.after_save :sync_variants_with_flow
     end
 
     def price_in_zone(currency, product_zone)
@@ -86,6 +87,10 @@ module Spree
       prices
     end
 
+    def sync_variants_with_flow
+      variants_including_master.each(&:sync_product_to_flow)
+    end
+
     Spree::Product.prepend(self) if Spree::Product.included_modules.exclude?(self)
   end
 end

data/app/models/spree/flow_io_variant_decorator.rb

@@ -49,15 +49,23 @@ module Spree
       product.update_columns(meta: product.meta.to_json)
     end
 
+    def sync_flow_info?
+      if FlowcommerceSpree::API_KEY.blank? || FlowcommerceSpree::API_KEY == 'test_key'
+        return { error: 'Api Keys not configured' }
+      end
+      return { error: 'Price is 0' } if price == 0
+      return { error: 'Country of Origin is empty.' } unless country_of_origin
+    end
+
     # upload product variant to Flow's Product Catalog
     def sync_product_to_flow
-      # initial Spree seed will fail, so skip unless we have Flow data field
-      return unless respond_to?(:flow_data)
+      error = sync_flow_info?
+      return error if error.present?
 
-      return if FlowcommerceSpree::API_KEY.blank? || FlowcommerceSpree::API_KEY == 'test_key'
-
-      return { error: 'Price is 0' } if price == 0
+      update_flow_data
+    end
 
+    def update_flow_data
       additional_attrs = {}
       attr_name = nil
       export_required = false
@@ -82,7 +90,7 @@ module Spree
       flow_item_sh1 = Digest::SHA1.hexdigest(flow_item.to_json)
 
       # skip if sync not needed
-      return nil if flow_data&.[](:last_sync_sh1) == flow_item_sh1
+      return { error: 'Synchronization not needed' } if flow_data&.[](:last_sync_sh1) == flow_item_sh1
 
       response = FlowcommerceSpree.client.items.put_by_number(FlowcommerceSpree::ORGANIZATION, sku, flow_item)
       self.flow_data ||= {}
@@ -91,6 +99,8 @@ module Spree
       # after successful put, write cache
       update_column(:meta, meta.to_json)
 
+      FlowcommerceSpree::ImportItemWorker.perform_async(sku)
+
       response
     rescue Net::OpenTimeout => e
       { error: e.message }