flowcommerce_spree 0.0.1

data/app/services/flowcommerce_spree/order_sync.rb

@@ -0,0 +1,231 @@
+# frozen_string_literal: true
+
+module FlowcommerceSpree
+  # represents flow.io order syncing service
+  # for easy integration we are currently passing:
+  # - flow experience
+  # - spree order
+  # - current customer, present as  @current_spree_user controller instance variable
+  #
+  # example:
+  #  flow_order = FlowcommerceSpree::OrderSync.new    # init flow-order object
+  #    order: Spree::Order.last,
+  #    experience: @flow_session.experience
+  #    customer: Spree::User.last
+  #  flow_order.build_flow_request           # builds json body to be posted to flow.io api
+  #  flow_order.synchronize!                 # sends order to flow
+  class OrderSync
+    FLOW_CENTER = 'default'
+
+    attr_reader :digest, :order, :response
+
+    class << self
+      def clear_cache(order)
+        return unless order.flow_data['order']
+
+        order.flow_data.delete('order')
+        order.update_column :meta, order.meta.to_json
+      end
+    end
+
+    def initialize(order:)
+      raise(ArgumentError, 'Experience not defined or not active') unless order.zone&.flow_io_active_experience?
+
+      @client = FlowcommerceSpree.client(session_id: order.flow_data['session_id'])
+      @experience = order.flow_io_experience_key
+      @order      = order
+      @customer   = order.user
+      @items      = []
+    end
+
+    # helper method to send complete order from Spree to flow.io
+    def synchronize!
+      sync_body!
+      check_state!
+      write_response_in_cache
+      @response
+    end
+
+    def error
+      @response['messages'].join(', ')
+    end
+
+    def error_code
+      @response['code']
+    end
+
+    def error?
+      @response&.[]('code') && @response&.[]('messages') ? true : false
+    end
+
+    def delivery
+      deliveries.select { |el| el[:active] }.first
+    end
+
+    # delivery methods are defined in flow console
+    def deliveries
+      # if we have erorr with an order, but still using this method
+      return [] unless @order.flow_order
+
+      @order.flow_data ||= {}
+
+      delivery_list = @order.flow_order['deliveries'][0]['options']
+      delivery_list = delivery_list.map do |opts|
+        name = opts['tier']['name']
+
+        # add original Flow ID
+        # name        += ' (%s)' % opts['tier']['strategy'] if opts['tier']['strategy']
+
+        selection_id = opts['id']
+
+        { id: selection_id,
+          price: { label: opts['price']['label'] },
+          active: @order.flow_order['selections'].include?(selection_id),
+          name: name }
+      end.to_a
+
+      # make first one active unless we have active element
+      delivery_list.first[:active] = true unless delivery_list.select { |el| el[:active] }.first
+
+      delivery_list
+    end
+
+    def total_price
+      @order.flow_total
+    end
+
+    def delivered_duty
+      # paid is default
+      @order.flow_data['delivered_duty'] || ::Io::Flow::V0::Models::DeliveredDuty.paid.value
+    end
+
+    # builds object that can be sent to api.flow.io to sync order data
+    def build_flow_request
+      @order.line_items.each { |line_item| add_item(line_item) }
+
+      @opts = {}
+      @opts[:experience]   = @experience
+      @opts[:expand]       = ['experience']
+
+      @body = { items: @items, number: @order.number }
+
+      add_customer if @customer
+
+      if (flow_data = @order.flow_data['order'])
+        @body[:selections] = flow_data['selections'].presence
+        @body[:delivered_duty] = flow_data['delivered_duty'].presence
+        @body[:attributes] = flow_data['attributes'].presence
+
+        if @order.adjustment_total != 0
+          # discount on full order is applied
+          @body[:discount] = { amount: @order.adjustment_total, currency: @order.currency }
+        end
+      end
+
+      # calculate digest body and cache it
+      @digest = Digest::SHA1.hexdigest(@opts.to_json + @body.to_json)
+    end
+
+    private
+
+    # if customer is defined, add customer info
+    # it is possible to have order in Spree without customer info (new guest session)
+    def add_customer
+      return unless @customer
+
+      address = @customer.ship_address
+      # address = nil
+      if address
+        @body[:customer] = { name: { first: address.firstname,
+                                     last: address.lastname },
+                             email: @customer.email,
+                             number: @customer.flow_number,
+                             phone: address.phone }
+
+        streets = []
+        streets.push address.address1 unless address.address1.blank?
+        streets.push address.address2 unless address.address2.blank?
+
+        @body[:destination] = { streets: streets,
+                                city: address.city,
+                                province: address.state_name,
+                                postal: address.zipcode,
+                                country: (address.country.iso3 || 'USA'),
+                                contact: @body[:customer] }
+
+        @body[:destination].delete_if { |_k, v| v.nil? }
+      end
+
+      @body
+    end
+
+    def sync_body!
+      build_flow_request if @body.blank?
+
+      @use_get = false
+
+      # use get if order is completed and closed
+      @use_get = true if @order.state == 'complete'
+
+      # use get if local digest hash check said there is no change
+      @use_get ||= true if @order.flow_data['digest'] == @digest
+
+      # do not use get if there is no local order cache
+      @use_get = false unless @order.flow_data['order']
+
+      if @use_get
+        @response ||= FlowcommerceSpree::Api.run :get, "/:organization/orders/#{@body[:number]}", expand: 'experience'
+      else
+        @response = @client.orders.put_by_number(FlowcommerceSpree::ORGANIZATION, @order.number,
+                                                 Io::Flow::V0::Models::OrderPutForm.new(@body), @opts).to_hash
+      end
+    end
+
+    def check_state!
+      # authorize if not authorized
+      # if !@order.flow_order_authorized?
+
+      # authorize payment on complete, unless authorized
+      if @order.state == 'complete' && !@order.flow_order_authorized?
+        simple_gateway = Flow::SimpleGateway.new(@order)
+        simple_gateway.cc_authorization
+      end
+
+      @order.flow_finalize! if @order.flow_order_authorized? && @order.state != 'complete'
+    end
+
+    def add_item(line_item)
+      variant    = line_item.variant
+      price_root = variant.flow_data&.dig('exp', @experience, 'prices')&.[](0) || {}
+
+      # create flow order line item
+      item = { center: FLOW_CENTER,
+               number: variant.sku,
+               quantity: line_item.quantity,
+               price: { amount: price_root['amount'] || variant.cost_price,
+                        currency: price_root['currency'] || variant.cost_currency } }
+
+      @items.push item
+    end
+
+    # set cache for total order ammount
+    # written in flow_data field inside spree_orders table
+    def write_response_in_cache
+      if !@response || error?
+        @order.flow_data.delete('digest')
+        @order.flow_data.delete('order')
+      else
+        response_total = @response.dig('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 == cache_total
+
+        # update local order
+        @order.flow_data.merge!('digest' => @digest, 'order' => @response.to_hash)
+      end
+
+      @order.update_column(:meta, @order.meta.to_json)
+    end
+  end
+end

data/app/views/layouts/flowcommerce_spree/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>FlowcommerceSpree</title>
+  <%= stylesheet_link_tag    "flowcommerce_spree/application", media: "all" %>
+  <%= javascript_include_tag "flowcommerce_spree/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

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

@@ -0,0 +1,28 @@
+<%= render partial: 'spree/admin/shared/order_tabs', locals: { current: 'Payments' } %>
+
+<% content_for :page_actions do %>
+  <% if @order.outstanding_balance? %>
+    <li id="new_payment_section">
+      <%= button_link_to Spree.t(:new_payment), new_admin_order_payment_url(@order), icon: 'plus' %>
+    </li>
+  <% end %>
+  <li><%= button_link_to Spree.t(:back_to_orders_list), admin_orders_path, icon: 'arrow-left' %></li>
+<% end %>
+
+<% content_for :page_title do %>
+  <i class="fa fa-arrow-right"></i> <%= Spree.t(:payments) %>
+<% end %>
+
+<% if @order.outstanding_balance? %>
+  <h5 class="outstanding-balance"><%= @order.outstanding_balance < 0 ? Spree.t(:credit_owed) : Spree.t(:balance_due) %>: <strong><%= @order.display_outstanding_balance %></strong></h5>
+<% end %>
+
+<% if @payments.any? %>
+  <%= render partial: 'list', :locals => { :payments => @payments } %>
+<% else %>
+  <div class="alpha twelve columns no-objects-found"><%= Spree.t(:order_has_no_payments) %></div>
+<% end %>
+
+<!-- SHOW REFUNDS START -->
+<%= render '/flow/show_refunds' %>
+<!-- SHOW REFUNDS END -->

data/app/views/spree/admin/promotions/edit.html.erb

@@ -0,0 +1,57 @@
+<% content_for :page_title do %>
+  <%= Spree.t(:editing_promotion) %>
+<% end %>
+
+<% content_for :page_actions do %>
+  <li>
+    <%= button_link_to Spree.t(:back_to_promotions_list), admin_promotions_path, icon: 'arrow-left' %>
+  </li>
+<% end %>
+
+<%= form_for @promotion, url: object_url, method: :put do |f| %>
+  <fieldset class="no-border-top">
+    <%= render partial: 'form', locals: { f: f } %>
+    <%= render partial: 'spree/admin/shared/edit_resource_links' %>
+  </fieldset>
+<% end %>
+
+<div id="promotion-filters" class="row">
+  <div id="rules_container" class="alpha eight columns">
+    <%= render partial: 'rules' %>
+  </div>
+
+  <div id="actions_container" class="omega eight columns">
+    <%= render partial: 'actions' %>
+  </div>
+</div>
+
+<%= render partial: 'spree/admin/variants/autocomplete', :formats => [:js] %>
+
+<!-- Flow filters experience -->
+
+<%
+  @promotion_keys = @promotion.flow_data.dig('filter', 'experience') || []
+%>
+
+<script>
+window.promotion_set_option = function(key_name, value) {
+  var opts = {
+    id: <%= @promotion.id %>,
+    type: 'experience',
+    name: key_name,
+    value: value ? 1 : 0
+  };
+
+  $.post('/flow/promotion_set_option', opts, function(r) { console.log(r); });
+}
+</script>
+
+<fieldset>
+  <legend align="center">Enable for Flow experiences</legend>
+
+  <p>Promotion will be enabled for all experiences unless a selection is made.</p>
+
+  <% for experience in FlowcommerceSpree::ExperienceService.all %>
+    <p><label><input type="checkbox" onclick="promotion_set_option('<%= experience.key %>', this.checked);" <%= @promotion_keys.include?(experience.key) ? 'checked="1"' : '' %> /> <%= experience.key %></label></p>
+  <% end %>
+</fieldset>

data/app/views/spree/admin/shared/_order_summary.html.erb

@@ -0,0 +1,44 @@
+<header id="order_tab_summary" data-hook>
+  <dl class="additional-info">
+    <dt id="order_status" data-hook><%= Spree.t(:status) %>:</dt>
+    <dd><span class="state <%= @order.state %>"><%= Spree.t(@order.state, scope: :order_state) %></span></dd>
+    <dt data-hook='admin_order_tab_subtotal_title'><%= Spree.t(:subtotal) %>:</dt>
+    <dd id='item_total'><%= @order.display_item_total.to_html %></dd>
+    <% if checkout_steps.include?("delivery") && @order.ship_total > 0 %>
+      <dt data-hook='admin_order_tab_ship_total_title'><%= Spree.t(:ship_total) %>:</dt>
+      <dd id='ship_total'><%= @order.display_ship_total.to_html %></dd>
+    <% end %>
+
+    <% if @order.included_tax_total != 0 %>
+      <dt data-hook='admin_order_tab_included_tax_title'><%= Spree.t(:tax_included) %>:</dt>
+      <dd id='included_tax_total'><%= @order.display_included_tax_total.to_html %></dd>
+    <% end %>
+
+    <% if @order.additional_tax_total != 0 %>
+      <dt data-hook='admin_order_tab_additional_tax_title'><%= Spree.t(:tax) %>:</dt>
+      <dd id='additional_tax_total'><%= @order.display_additional_tax_total.to_html %></dd>
+    <% end %>
+
+    <dt data-hook='admin_order_tab_total_title'><%= Spree.t(:total) %>:</dt>
+    <dd id='order_total'><%= @order.display_total.to_html %></dd>
+
+    <% if @order.completed? %>
+      <dt><%= Spree.t(:shipment) %>: </dt>
+      <dd id='shipment_status'><span class="state <%= @order.shipment_state %>"><%= Spree.t(@order.shipment_state, scope: :shipment_states, default: [:missing, "none"]) %></span></dd>
+      <dt><%= Spree.t(:payment) %>: </dt>
+      <dd id='payment_status'><span class="state <%= @order.payment_state %>"><%= Spree.t(@order.payment_state, scope: :payment_states, default: [:missing, "none"]) %></span></dd>
+      <dt data-hook='admin_order_tab_date_completed_title'><%= Spree.t(:date_completed) %>:</dt>
+      <dd id='date_complete'><%= pretty_time(@order.completed_at) %></dd>
+    <% end %>
+
+    <% if @order.approved? %>
+      <dt><%= Spree.t(:approver) %></dt>
+      <dd><%= @order.approver.email %></dd>
+      <dt><%= Spree.t(:approved_at) %></dt>
+      <dd><%= pretty_time(@order.approved_at) %></dd>
+    <% end %>
+  </dl>
+</header>
+
+<!-- Add Flow order summary, if available -->
+<%= render partial: 'spree/admin/shared/order_summary_flow' %>

data/app/views/spree/admin/shared/_order_summary_flow.html.erb

@@ -0,0 +1,13 @@
+<hr />
+
+<h5 class="sidebar-title">Flow details</h5>
+
+<%= total_cart_breakdown %>
+
+<% if @order.flow_data['order'] %>
+  <p>Experience: <b><%= @order.flow_data.dig('order', 'experience', 'key') %></b></p>
+  <a target="_fc_<%= @order.id %>" href="https://console.flow.io/<%= FlowcommerceSpree::ORGANIZATION %>/orders/<%= @order.number %>">Open in Flow console</a>
+<% else %>
+  <p>Order is not localized with Flow.</p>
+<% end %>
+

data/app/views/spree/order_mailer/confirm_email.html.erb

@@ -0,0 +1,86 @@
+<%
+  # render text email in console. parts[1] for html body
+  # puts Spree::OrderMailer.confirm_email(Spree::Order.last).body.parts[0].body
+
+  @prices      = @order.flow_cart_breakdown
+  @total_price = @prices.pop
+%>
+
+<style>
+  table.order td { padding: 4px; border-top: 1px solid #bbb; }
+</style>
+
+<h6>Dear <%= @order.bill_address.firstname %></h6>
+
+<br>
+<br>
+
+<p><%= Spree.t('order_mailer.confirm_email.instructions') %></p>
+<p><%= Spree.t('order_mailer.confirm_email.order_summary') %></p>
+
+<table class="order">
+  <tr>
+    <th>Product</th>
+    <th width="100" align="right">Price</th>
+    <th width="80" align="center">Quantity</th>
+    <th width="100" align="right">Total</th>
+  </tr>
+  <% @order.line_items.each do |line_item| %>
+    <tr>
+      <td><%= line_item.variant.product.name %></td>
+      <td align="right"><%= @order.flow_line_item_price(line_item) %></td>
+      <td align="center"><%= line_item.quantity %></td>
+      <td align="right"><%= @order.flow_line_item_price(line_item, :with_quantity) %></td>
+    </tr>
+  <% end %>
+</table>
+
+<br>
+
+<p><b>Total</b></p>
+
+<table class="order">
+
+  <% @prices.each do |price| %>
+    <tr><td width="120"><%= price.name.capitalize %></td><td align="right"><%= price.label %></td></tr>
+  <% end %>
+
+  <tr>
+    <td><%= Spree.t(:total) %></td>
+    <td align="right"><b><%= @total_price.label %></b></td>
+  </tr>
+  <tr>
+    <td>Payment method</td>
+    <td align="right"><%= @order.flow_payment_method == 'paypal' ? 'PayPal' : 'Credit Card' %></td>
+  </tr>
+</table>
+
+<br>
+
+<% ['ship', 'bill'].each do |name|
+  address = @order.send('%s_address' % name)
+%>
+<p><b><%= name.capitalize %>ing address</b></p>
+
+<table class="order">
+  <tr>
+    <td>Full name</td>
+    <td><%= address.firstname %> <%= address.lastname %></td>
+  </tr>
+  <tr>
+    <td>Address</td>
+    <td><%= address.address1 %></td>
+  </tr>
+  <tr>
+    <td>City</td>
+    <td><%= address.city %></td>
+  </tr>
+  <tr>
+    <td>Country</td>
+    <td><%= address.country.name rescue '-' %>, <%= address.state.name rescue '-' %></td>
+  </tr>
+</table>
+<br />
+<% end %>
+
+<p><%= Spree.t('order_mailer.confirm_email.thanks') %></p>