workarea-listrak 5.0.1

data/app/services/workarea/listrak/models/order_item.rb

@@ -0,0 +1,197 @@
+module Workarea
+  module Listrak
+    module Models
+      class OrderItem
+
+        attr_reader :order, :order_item
+
+        def initialize(order, order_item)
+          @order = order
+          @order_item = order_item
+        end
+
+        def as_json
+          {
+            discountDescription: discount_description,
+            discountType: discount_type,
+            discountedPrice: discount_price,
+            itemTotal: item_total,
+            itemDiscountTotal: item_discount_total,
+            meta1: meta1,
+            meta2: meta2,
+            meta3: meta3,
+            meta4: meta4,
+            meta5: meta5,
+            orderNumber: order_number,
+            price: price,
+            quantity: quantity,
+            shipDate: ship_date,
+            shippingMethod: shipping_method,
+            sku: sku,
+            status: status,
+            trackingNumber: tracking_number
+          }
+        end
+
+        # Description of the discount for the line item
+        #
+        # @return [String]
+        #
+        def discount_description
+        end
+
+        # Type of discount for the line item
+        #
+        # "NotSet" "PriceOverride" "PriceRule" "Promotion" "SeniorCitizen" "Markdown" "Coupon" "QuantityDiscount" "Rebate" "CashDiscount" "TradeDiscount" "TradeInKind" "PromptPaymentDiscount" "GeneralDiscount" "GiftVoucher" "FlexibleDiscount" "RewardProgram" "ManufacturerReward" "CreditCardReward"
+        #
+        # @return [String]
+        #
+        def discount_type
+        end
+
+        # Total discounted cost of product
+        #
+        # @return [Float]
+        #
+        def discount_price
+          order_item.price_adjustments
+            .select { |pa| pa.data['discount_value'].present? && pa.price == 'item' }
+            .sum { |d| d.data['discount_value'] }
+            .abs
+        end
+
+        # Total line item cost (quantity times price)
+        #
+        # @return [Float]
+        #
+        def item_total
+          order_item.total_value.to_f
+        end
+
+        # Total amount of the discount for the line item
+        #
+        # @return [Float]
+        #
+        def item_discount_total
+          order_item.price_adjustments
+            .select { |pa| pa.data['discount_value'].present? && pa.price == 'item' }
+            .sum { |d| d.data['discount_value'] }
+            .abs
+        end
+
+        # Additional Optional Information
+        #
+        # limited to 500 characters
+        #
+        # @return [String]
+        #
+        def meta1
+        end
+
+        # Additional Optional Information
+        #
+        # limited to 500 characters
+        #
+        # @return [String]
+        #
+        def meta2
+        end
+
+        # Additional Optional Information
+        #
+        # limited to 500 characters
+        #
+        # @return [String]
+        #
+        def meta3
+        end
+
+        # Additional Optional Information
+        #
+        # limited to 500 characters
+        #
+        # @return [String]
+        #
+        def meta4
+        end
+
+        # Additional Optional Information
+        #
+        # limited to 500 characters
+        #
+        # @return [String]
+        #
+        def meta5
+        end
+
+        # Order number
+        #
+        # limited to 50 characters
+        #
+        # @return [String]
+        #
+        def order_number
+          order.id.to_s
+        end
+
+        # Price of one unit purchased
+        #
+        # @return [Float]
+        #
+        def price
+          order_item.original_unit_price.to_f
+        end
+
+        # Total number of units purchased
+        #
+        # return [Integer]
+        #
+        def quantity
+          order_item.quantity
+        end
+
+        # Timestamp when item shipped (ET)
+        #
+        # @return [String] DateTime in %FT%TZ
+        #
+        def ship_date
+        end
+
+        # Shipping method (e.g. UPS Ground)
+        #
+        # limited to 32 characters
+        #
+        # @return [String]
+        #
+        def shipping_method
+        end
+
+        # Unique stock number of product
+        #
+        # limited to 100 characters
+        #
+        # @return [String]
+        #
+        def sku
+          order_item.sku
+        end
+
+        # Status indicator
+        #
+        # "NotSet" "Misc" "PreOrder" "BackOrder" "Pending" "Hold" "Processing" "Shipped" "Completed" "Returned" "Canceled" "Unknown" "Closed"
+        #
+        # @return [String]
+        #
+        def status
+        end
+
+        # Shipment tracking number
+        #
+        # limited to 32 characters
+        #
+        def tracking_number
+        end
+      end
+    end
+  end
+end

data/app/services/workarea/listrak/models/product_form.rb

@@ -0,0 +1,369 @@
+module Workarea
+  module Listrak
+    module Models
+      class ProductForm
+        include ActionView::Helpers::AssetUrlHelper
+        include Workarea::I18n::DefaultUrlOptions
+        include Workarea::ApplicationHelper
+        include Storefront::Engine.routes.url_helpers
+
+
+        # @param [Workarea::Catalog::Product] product
+        # @param [String] sku
+        def initialize(product, sku, pricing_sku: nil, inventory_sku: nil)
+          @product = product
+          @sku = sku
+          @pricing_sku = pricing_sku
+          @inventory_sku = inventory_sku
+        end
+
+        def as_json(_options)
+          {
+            brand: brand,
+            category: category,
+            color: color,
+            description: description,
+            discontinued: discontinued,
+            gender: gender,
+            imageUrl: image_url,
+            inStock: in_stock,
+            isClearance: is_clearence,
+            isOutlet: is_outlet,
+            isPurchasable: is_purchasable,
+            isViewable: is_viewable,
+            linkUrl: link_url,
+            masterSku: master_sku,
+            meta1: meta1,
+            meta2: meta2,
+            meta3: meta3,
+            meta4: meta4,
+            meta5: meta5,
+            msrp: msrp,
+            onSale: on_sale,
+            price: price,
+            qoh: quantity_on_hand,
+            saleEndDate: sale_end_date,
+            salePrice: sale_price,
+            saleStartDate: sale_start_date,
+            size: size,
+            sku: sku,
+            style: style,
+            subCategory: sub_category,
+            title: title,
+            unitCost: unit_cost
+          }.compact
+        end
+
+        # Brand name of product
+        #
+        # limited to 50 characters
+        #
+        # @return [String]
+        #
+        def brand
+          product.try(:brand)
+        end
+
+        # Category or department
+        #
+        # limited to 50 characters
+        #
+        # @return [String]
+        #
+        def category
+          categorization.default_model.try(:name)
+        end
+
+        # Color of product (e.g. green, paisley, etc.)
+        #
+        # limited to 100 characters
+        #
+        # @return [String]
+        #
+        def color
+          variant.fetch_detail('color')
+        end
+
+        # Description of product
+        #
+        # limited to 4000 characters
+        #
+        # @return [String]
+        #
+        def description
+          product.description
+        end
+
+        # Explicit indicator that the item has been discontinued
+        #
+        # @return [Boolean]
+        #
+        def discontinued
+        end
+
+        # Gender of product (if applicable)
+        #
+        # limited to 50 characters
+        #
+        # @return [String]
+        #
+        def gender
+        end
+
+        # URL for product image
+        #
+        # limited to 500 characters
+        #
+        # @return [String]
+        #
+        def image_url
+          return unless image = variant_image || product.images.first
+          @image_url ||= product_image_url(image, :detail)
+        end
+
+        # Explicit indicator that the item is in stock
+        #
+        # @return [Boolean]
+        #
+        def in_stock
+          quantity_on_hand > 0
+        end
+
+        # Explicit indicator that the item is a clearance item
+        #
+        # @return [Boolean]
+        #
+        def is_clearence
+        end
+
+        # Explicit indicator that the item is an outlet item
+        #
+        # @return [Boolean]
+        #
+        def is_outlet
+        end
+
+        # Explicit indicator that the item can be included in recommendations
+        #
+        # @return [Boolean]
+        #
+        def is_purchasable
+          product.purchasable? && inventory_sku.purchasable?
+        end
+
+        # Flag used in some systems to determine if the item should be included in recommendations
+        #
+        # @return [Boolean]
+        #
+        def is_viewable
+          product.purchasable? && inventory_sku.purchasable?
+        end
+
+        # URL for product webpage
+        #
+        # limited to 500 characters
+        #
+        # @return [String]
+        #
+        def link_url
+          product_url(product, host: Workarea.config.host)
+        end
+
+        # Unique stock number of the master product
+        #
+        # limited to 100 characters
+        #
+        # @return [String]
+        #
+        def master_sku
+          product.id.to_s
+        end
+
+        # Additional meta imformation
+        #
+        # limted to 500 characters
+        #
+        # @return [String]
+        #
+        def meta1
+        end
+
+        # Additional meta imformation
+        #
+        # limted to 500 characters
+        #
+        # @return [String]
+        #
+        def meta2
+        end
+
+        # Additional meta imformation
+        #
+        # limted to 500 characters
+        #
+        # @return [String]
+        #
+        def meta3
+        end
+
+        # Additional meta imformation
+        #
+        # limted to 500 characters
+        #
+        # @return [String]
+        #
+        def meta4
+        end
+
+        # Additional meta imformation
+        #
+        # limted to 500 characters
+        #
+        # @return [String]
+        #
+        def meta5
+        end
+
+        # Retail price of the product
+        #
+        # @return [Float]
+        #
+        def msrp
+        end
+
+        # Explicit indicator that the item is on sale
+        #
+        # @return [Boolean
+        #
+        def on_sale
+          pricing_sku.on_sale?
+        end
+
+        # List price of product
+        #
+        # @return [Float]
+        #
+        def price
+          pricing_sku.find_price.sell.to_f
+        end
+
+        # Quantity on hand
+        #
+        # return [Integer]
+        #
+        def quantity_on_hand
+          inventory_sku.available
+        end
+
+        # End date time of sale
+        #
+        # @return [String] sale_end_date DateTime in %FT%TZ
+        #
+        def sale_end_date
+        end
+
+        # Sale price of product
+        #
+        # @return [Float
+        #
+        def sale_price
+          pricing_sku.find_price.sale.to_f
+        end
+
+        # Start date time of sale
+        #
+        # @return [String] sale_start_date DateTime in %FT%TZ
+        #
+        def sale_start_date
+        end
+
+        # Size of product (e.g. small, M, 6 7/8”)
+        #
+        # limited to 50 characters
+        #
+        # @return [String]
+        #
+        def size
+          variant.fetch_detail('size')
+        end
+
+        # Unique stock number of product
+        #
+        # limited to 100 characters
+        #
+        # @return [String]
+        #
+        def sku
+          @sku
+        end
+
+        # Style of product
+        #
+        # limited to 100 characters
+        #
+        # @return [String]
+        #
+        def style
+        end
+
+        # Sub-category or sub-department
+        #
+        # limited to 50 characters
+        #
+        # @return [String]
+        #
+        def sub_category
+          categorization.secondary_model.try(:name)
+        end
+
+        # Product name
+        #
+        # limited to 500 characters
+        #
+        # @return [String]
+        #
+        def title
+          product.name
+        end
+
+        # Price per individual item
+        #
+        # @return [Float]
+        #
+        def unit_cost
+        end
+
+        private
+
+          attr_reader :product
+
+          def categorization
+            @categorization ||= Categorization.new(product)
+          end
+
+          def variant
+            @variant ||= product.variants.find_by(sku: sku)
+          end
+
+          def pricing_sku
+            @pricing_sku ||= Pricing::Sku.find sku
+          end
+
+          def inventory_sku
+            @inventory_sku ||= Inventory::Sku.find sku
+          end
+
+          def variant_image
+            @variant_image ||=
+              begin
+                sku_options = variant.details.values.flat_map { |options| options.map(&:optionize) }
+
+                product.images.detect do |image|
+                  sku_options.include?(image.option.optionize)
+                end
+              end
+          end
+      end
+    end
+  end
+end

data/app/services/workarea/listrak/models/transactional_message_form.rb

@@ -0,0 +1,21 @@
+module Workarea
+  module Listrak
+    module Models
+      class TransactionalMessageForm
+        attr_reader :email_address, :segmentation_field_values
+
+        def initialize(email_address:, segmentation_field_values: [])
+          @email_address = email_address
+          @segmentation_field_values = segmentation_field_values
+        end
+
+        def to_json
+          {
+            emailAddress: email_address,
+            segmentationFieldValues: segmentation_field_values
+          }.compact.to_json
+        end
+      end
+    end
+  end
+end

data/app/services/workarea/listrak/oauth.rb

@@ -0,0 +1,45 @@
+module Workarea
+  module Listrak
+    module Oauth
+      # Generates an oauth token for a client_id and client_secret.
+      #
+      # @param client_id [String] client id
+      # @param client_secret [String] client secret
+      # @param options [Hash] extra options when getting the OAuth token
+      # @option options [Integer] timeout value for open and read timeouts
+      # @option options [Integer] open_timeout value for open timeout
+      # @option options [Integer] read_timeout value for read timeout
+      #
+      # @raise [OauthError] raised if generating an Oauth token is unsucessful
+      #
+      # @return [String] Oauth token
+      def self.token(client_id:, client_secret:, **options)
+        cache_key = "listrak/api/#{client_id}"
+        token = Rails.cache.read(cache_key)
+
+        return token if token.present?
+
+        uri = URI('https://auth.listrak.com/OAuth2/Token')
+        params = {
+          grant_type: 'client_credentials',
+          client_id: client_id,
+          client_secret: client_secret
+        }
+
+        response = Net::HTTP.post_form uri, params
+
+        case response
+        when ::Net::HTTPSuccess
+          body = JSON.parse response.body
+          token = body["access_token"]
+          expiry = body["expires_in"] - 60
+
+          Rails.cache.write(cache_key, token, expires_in: expiry)
+          token
+        else
+          raise OauthError.new response
+        end
+      end
+    end
+  end
+end

data/app/services/workarea/listrak/transactional_message.rb

@@ -0,0 +1,83 @@
+module Workarea
+  module Listrak
+    # Base functionality for Listrak message sender classes.
+    # +Listrak::TransactionalMessage+ objects wrap a call to the
+    # Listrak REST API and allow the user to cleanly define
+    # attribute ID / value pairs and "name" them by defining
+    # attribute values as method calls.
+    #
+    # @example
+    #   module Workarea
+    #     class OrderConfirmationMessage
+    #       include Listrak::TransactionalMessage
+    #
+    #       message_id 12345
+    #       message_attributes name: 67890
+    #
+    #       def initialize(model)
+    #         @model = model
+    #       end
+    #
+    #       def name
+    #         @model.class.name
+    #       end
+    #
+    #       private
+    #
+    #         def email_address
+    #           model.email_address
+    #         end
+    #     end
+    #   end
+    module TransactionalMessage
+      extend ActiveSupport::Concern
+
+      included do
+        class_attribute :listrak_message_id
+        class_attribute :transactional_attributes
+      end
+
+      class_methods do
+        def message_id(id)
+          self.listrak_message_id = id
+        end
+
+        def message_attributes(attributes)
+          self.transactional_attributes = attributes.symbolize_keys
+        end
+      end
+
+      # @abstract Subclass is expected to implement #email_address
+      # @!method email_address
+      #    Email address to deliver this message to
+
+      # Sends the transactional mesasge
+      #
+      # @return [nil]
+      #
+      def deliver
+        transactional_message_form = Listrak::Models::TransactionalMessageForm.new(
+          email_address: email_address,
+          segmentation_field_values: segmentation_field_values
+        )
+
+        Listrak.email.transactional_messages.create(
+          Listrak.configuration.default_list_id,
+          listrak_message_id,
+          transactional_message_form
+        )
+        nil
+      end
+
+      private
+
+        # @return [Array<Hash>]
+        #
+        def segmentation_field_values
+          transactional_attributes.map do |name, id|
+            { segmentationFieldId: id, value: send(name).to_s }
+          end
+        end
+    end
+  end
+end