gemgento 2.8.0

data/app/models/gemgento/address.rb

@@ -0,0 +1,206 @@
+module Gemgento
+
+  # @author Gemgento LLC
+  class Address < ActiveRecord::Base
+    belongs_to :addressable, polymorphic: true, class_name: 'Gemgento::Address'
+    belongs_to :country, class_name: 'Gemgento::Country'
+    belongs_to :region, class_name: 'Gemgento::Region'
+
+    has_one :shopify_adapter, class_name: 'Adapter::ShopifyAdapter', as: :gemgento_model
+
+    attr_accessor :address1, :address2, :address3, :copy_to_user
+
+    validates :region, presence: true, if: Proc.new { |address| !address.country.nil? && address.country.regions.any? }
+    validates_uniqueness_of :addressable_id,
+                            scope: [:addressable_type, :street, :city, :country, :region, :postcode, :telephone],
+                            message: 'address is not unique',
+                            if: :is_addressable_user?
+
+    after_find :explode_street_address
+    before_validation :strip_whitespace, :implode_street_address
+
+    before_create :create_magento_address, if: :create_magento_address?
+    before_update :update_magento_address, if: :update_magento_address?
+    before_destroy :destroy_magento_address, if: :update_magento_address?
+
+    after_save :enforce_single_default, if: :is_addressable_user?
+    after_save :copy_from_addressable_to_user, if: :copy_from_addressable_to_user?
+
+    default_scope -> { order(is_billing: :desc, is_shipping: :desc, updated_at: :desc) }
+
+    # Return the Address as JSON.
+    #
+    # @param options [Hash] an optional hash of options.
+    # @return [String]
+    def as_json(options = nil)
+      result = super
+      result['address1'] = self.address1
+      result['address2'] = self.address2
+      result['address3'] = self.address3
+      result['country'] = self.country.name unless self.country.nil?
+      result['region'] = self.region.code unless self.region.nil?
+      return result
+    end
+
+    # Duplicate address from addressable user to user.
+    #
+    # @return [Gemgento::Address] the newly created Address.
+    def copy_from_addressable_to_user
+      address = duplicate
+      address.addressable = self.addressable.user
+      address.is_billing = self.is_billing
+      address.is_shipping = self.is_shipping
+      address.sync_needed = true
+      address.save
+
+      return address
+    end
+
+    # @return [Boolean]
+    def copy_from_addressable_to_user?
+      self.copy_to_user.to_bool && self.addressable.try(:user).is_a?(Gemgento::User)
+    end
+
+    # Set the street attribute.  Override required to explode the street into address lines.
+    def street=(value)
+      super
+      explode_street_address
+    end
+
+    # Duplicate an address.  Different from dup because it avoids unique magento attributes and includes
+    # country and region associations.
+    #
+    # @return [Gemgento::Address] newly duplicated address
+    def duplicate
+      address = self.dup
+      address.region = self.region
+      address.country = self.country
+      address.magento_id = nil
+      address.addressable = nil
+      address.is_billing = false
+      address.is_shipping = false
+      address.increment_id = nil
+      address.sync_needed = false
+
+      return address
+    end
+
+    def is_addressable_user?
+      self.addressable.is_a?(Gemgento::User)
+    end
+
+    # Check if a Magento address can be created.
+    #
+    # @return [Boolean]
+    def create_magento_address?
+      self.magento_id.nil? && self.is_addressable_user?
+    end
+
+    # Check if a Magento address can be updated.
+    #
+    # @return [Boolean]
+    def update_magento_address?
+      !self.magento_id.nil? && self.is_addressable_user?
+    end
+
+    private
+
+    # Strip attributes where leading/trailing whitespace could pose problems.
+    #
+    # @return [void]
+    def strip_whitespace
+      self.first_name = self.first_name.strip unless self.first_name.nil?
+      self.last_name = self.last_name.strip unless self.last_name.nil?
+      self.city = self.city.strip unless self.city.nil?
+      self.postcode = self.postcode.strip unless self.postcode.nil?
+    end
+
+    # Split the street attribute into 3 address line attributes. Magento stores street addresses lines as a
+    # single attribute that uses line breaks to differentiate the lines.
+    #
+    # @return [void]
+    def explode_street_address
+      return if self.street.nil?
+
+      address = self.street.split("\n")
+      self.address1 = address[0] unless address[0].blank?
+      self.address2 = address[1] unless address[1].blank?
+      self.address3 = address[2] unless address[2].blank?
+    end
+
+    # Combine the 3 address line attributes into a single street attribute.  Magento stores street addresses lines as a
+    # single attribute that uses line breaks to differentiate the lines.
+    #
+    # @return [void]
+    def implode_street_address
+      street = []
+      street << self.address1 unless self.address1.blank?
+      street << self.address2 unless self.address2.blank?
+      street << self.address3 unless self.address3.blank?
+      self.street = street.join("\n") unless street.blank?
+    end
+
+    # Create an associated address in Magento.
+    #
+    # @return [Boolean]
+    def create_magento_address
+      return true unless self.create_magento_address?
+
+      response = API::SOAP::Customer::Address.create(self)
+
+      if response.success?
+        self.magento_id = response.body[:result]
+        return true
+      else
+        errors.add(:base, response.body[:faultstring])
+        return false
+      end
+    end
+
+    # Update associated address in Magento.
+    #
+    # @return [Boolean]
+    def update_magento_address
+      return true unless self.update_magento_address?
+
+      response = API::SOAP::Customer::Address.update(self)
+
+      if response.success?
+        return true
+      else
+        errors.add(:base, response.body[:faultstring])
+        return false
+      end
+    end
+
+    # Destroy the address in Magento.  This is the before destroy callback.
+    #
+    # @return [void]
+    def destroy_magento_address
+      return true unless self.update_magento_address?
+
+      response = API::SOAP::Customer::Address.delete(self.magento_id)
+
+      if response.success?
+        return true
+      else
+        errors.add(:base, response.body[:faultstring])
+        return false
+      end
+    end
+
+    # Make sure the user has only one default Address for the type (shipping/billing).
+    #
+    # @return [void]
+    def enforce_single_default
+      if self.is_billing
+        self.addressable.addresses.where('id != ?', self.id).update_all(is_billing: false)
+      end
+
+      if self.is_shipping
+        self.addressable.addresses.where('id != ?', self.id).update_all(is_shipping: false)
+      end
+    end
+
+  end
+end

data/app/models/gemgento/api_job.rb

@@ -0,0 +1,68 @@
+module Gemgento
+
+  # @author Gemgento LLC
+  class ApiJob < ActiveRecord::Base
+    belongs_to :source, polymorphic: true
+
+    state_machine :state, initial: 'pending', use_transactions: false do
+      event :ready do
+        transition from: 'pending', to: 'ready'
+      end
+      event :active do
+        transition from: 'ready', to: 'active'
+      end
+      event :complete do
+        transition from: 'active', to: 'complete'
+        transition from: 'ready', to: 'complete'
+        transition from: 'error', to: 'complete'
+      end
+      event :error do
+        transition from: 'active', to: 'error'
+        transition from: 'ready', to: 'error'
+      end
+
+      before_transition to: 'ready', do: :is_ready!
+      before_transition to: 'complete', do: :is_completed!
+      after_transition to: 'error', do: :error!
+      after_transition to: 'complete', do: :finalize!
+    end
+
+    # Determine if the ApiJob is ready to be activated. This method needs to be overridden in the child class.
+    #
+    # @return [void]
+    def is_ready!
+    end
+
+    # Determine if the ApiJob is completed.  This method needs to be overridden in the child class.
+    #
+    # @return [void]
+    def is_completed!
+    end
+
+    # Print the ApiJob details after the ApiJob has transitioned to the error state.
+    #
+    # @return [void]
+    def error!
+      puts(self.inspect)
+    end
+
+    # Lock the ApiJob after it has transitioned to the complete state.
+    #
+    # @return [void]
+    def finalize!
+      self.update_attribute('locked', true)
+    end
+
+    # Perform the ApiJob.  This is meant to be overridden in the child class.  The requirements of overriding this
+    # method are to transition the ApiJob into the active state before doing anything, then upon completion, transition
+    # to either the complete or error state.
+    #
+    # @return [void]
+    def activate(payload)
+      self.active
+      # perform action here
+      self.complete
+    end
+
+  end
+end

data/app/models/gemgento/asset.rb

@@ -0,0 +1,185 @@
+require 'open-uri'
+
+module Gemgento
+
+  # @author Gemgento LLC
+  class Asset < ActiveRecord::Base
+    include Gemgento::ProductTouches
+
+    belongs_to :product, class_name: 'Gemgento::Product'
+    belongs_to :store, class_name: 'Gemgento::Store'
+    belongs_to :asset_file, class_name: 'Gemgento::AssetFile'
+
+    has_and_belongs_to_many :asset_types, join_table: 'gemgento_assets_asset_types'
+
+    validates :asset_file, :product_id, :store_id, presence: true
+    validates_uniqueness_of :product_id, scope: [:asset_file_id, :store_id, :file]
+
+    before_save :create_magento_product_attribute_media, if: -> { sync_needed? && file.blank? }
+    before_save :update_magento_product_attribute_media, if: -> { sync_needed? && !file.blank? }
+
+    before_destroy :delete_magento, :destroy_file
+
+    default_scope -> { includes(:asset_file).order(:position).references(:asset_file) }
+
+    # Associate an image file with the Asset.  If the same file is already associated to a related Asset in a
+    # different store, then the Asset will be associated with the existing AssetFile.
+    #
+    # @param file [File, TempFile] a file to be associated with the Asset
+    # @return [void]
+    def set_file(file)
+      matching_file = nil
+      matching_asset = nil
+
+      self.product.assets.each do |asset|
+        next if asset.asset_file.nil?
+        next if asset.store == self.store && asset.id != self.id # don't compare AssetFiles from the same store unless it's the same Asset
+
+        if File.exist?(asset.asset_file.file.path(:original)) && FileUtils.compare_file(asset.asset_file.file.path(:original), file)
+          matching_file = asset.asset_file
+          matching_asset = asset
+          break
+        end
+      end
+
+      if matching_file.nil?
+        begin
+          matching_file = AssetFile.new
+          matching_file.file = file
+          matching_file.save
+        rescue
+          matching_file = nil
+        end
+
+        matching_asset = Asset.new
+      end
+
+      self.asset_file = matching_file
+      self.file = matching_asset.file if self.file.blank? && !matching_asset.file.blank?
+    end
+
+    # Return the image file associated with the Asset.
+    #
+    # @return [Paperclip::Attachment, nil]
+    def image
+      if self.asset_file.nil?
+        nil
+      else
+        self.asset_file.file
+      end
+    end
+
+    # Associate AssetTypes to the Asset.
+    #
+    # @param asset_type_codes [Array(String)] asset type codes
+    # @return [void]
+    def set_types_by_codes(asset_type_codes)
+      applied_asset_types = []
+
+      # loop through each return category and add it to the product if needed
+      asset_type_codes.each do |asset_type_code|
+        next if asset_type_code.blank?
+
+        asset_type = AssetType.find_by(
+            product_attribute_set: self.product.product_attribute_set,
+            code: asset_type_code,
+        )
+        next if asset_type.nil?
+
+        self.asset_types << asset_type unless self.asset_types.include? asset_type # don't duplicate the asset types
+        applied_asset_types << asset_type.id
+
+        # an AssetType can only be associated to one asset for every
+        asset_type.assets.where(product_id: self.product_id, store_id: self.store_id).where('gemgento_assets.id != ?', self.id).find_each do |asset|
+          asset.asset_types.destroy(asset_type)
+        end
+      end
+
+      # destroy any asset type associations that were not in the list
+      self.asset_types.delete(AssetType.where('id NOT IN (?)', applied_asset_types))
+    end
+
+    # Find a products asset by the AssetType code
+    #
+    # @param product [Product]
+    # @param code [String]
+    # @param store [Integer, nil]
+    # @return [Asset, nil]
+    def self.find_by_code(product, code, store = nil)
+      product.assets
+          .joins(:asset_types)
+          .where(store: store || Gemgento::Store.current)
+          .where(gemgento_asset_types: { code: code, product_attribute_set_id: product.product_attribute_set_id })
+          .first
+    end
+
+    def as_json(options = {})
+      result = super
+
+      result[:styles] = {'original' => self.image.url(:original)}
+
+      self.image.styles.keys.to_a.each do |style|
+        result[:styles][style] = self.image.url(style.to_sym)
+      end
+
+      result[:types] = []
+      self.asset_types.each do |asset_type|
+        result[:types] << asset_type.code unless result[:types].include? asset_type.code
+      end
+
+      return result
+    end
+
+    private
+
+    # Create an associated ProductAttributeMedia in Magento.
+    #
+    # @return [Boolean]
+    def create_magento_product_attribute_media
+      response = API::SOAP::Catalog::ProductAttributeMedia.create(self)
+
+      if response.success?
+        self.file = response.body[:result]
+        return true
+      else
+        errors.add(:base, response.body[:faultstring])
+        return false
+      end
+    end
+
+    # Create an associated ProductAttributeMedia in Magento.
+    #
+    # @return [Boolean]
+    def update_magento_product_attribute_media
+      response = API::SOAP::Catalog::ProductAttributeMedia.update(self)
+
+      if response.success?
+        return true
+      else
+        errors.add(:base, response.body[:faultstring])
+        return false
+      end
+    end
+
+    # Destroy the Asset in Magento.  This is a before destroy callback.
+    #
+    # @return [void]
+    def delete_magento
+      if !self.file.blank? && (!self.asset_file.nil? && self.asset_file.assets.where('gemgento_assets.id != ?', self.id).empty?)
+        API::SOAP::Catalog::ProductAttributeMedia.remove(self)
+      end
+
+      self.asset_types.clear
+    end
+
+    # Destroy the associated AssetFile if it is not used by other Assets.  This is a before destroy callback.
+    #
+    # @return [void]
+    def destroy_file
+      if !self.asset_file.nil? && self.asset_file.assets.where('gemgento_assets.id != ?', self.id).empty?
+        self.asset_file.destroy
+      end
+    end
+
+  end
+end