gemgento 2.8.0

data/app/models/gemgento/tag.rb

@@ -0,0 +1,64 @@
+module Gemgento
+
+  # @author Gemgento LLC
+  class Tag < ActiveRecord::Base
+    has_many :store_tags, class_name: 'StoreTag'
+    has_many :stores, through: :store_tags
+
+    has_and_belongs_to_many :products, class_name: 'Product', join_table: 'gemgento_products_tags'
+
+    validates :name, uniqueness: true
+
+    before_save :create_magento_tag, if: -> { sync_needed? && magento_id.nil? }
+    before_save :update_magento_tag, if: -> { sync_needed? && !magento_id.nil? }
+
+    # Get the tag base popularity for a store.
+    #
+    # @param store [Store, nil]
+    # @return [Integer]
+    def base_popularity(store = nil)
+      self.store_tags.find_by(store: (store || self.stores.first)).base_popularity
+    end
+
+    private
+
+    # Create assocaited Magento Tag.
+    #
+    # @return [Boolean]
+    def create_magento_tag
+      response = API::SOAP::Catalog::ProductTag.manage(self, stores.first)
+
+      if response.success?
+        self.magento_id = response.body[:result]
+        self.sync_needed = false
+
+        stores.each_with_index do |store, i|
+          next if i == 0
+          response = API::SOAP::Catalog::ProductTag.manage(self, store)
+          self.sync_needed = true unless response.success?
+        end
+
+        return true
+      else
+        return false
+      end
+    end
+
+    # Update associated Magento Tag.
+    #
+    # @return [Boolean]
+    def update_magento_tag
+      self.stores.each do |store|
+        response = API::SOAP::Catalog::ProductTag.manage(self, store)
+
+        unless response.success?
+          errors.add(:base, response.body[:faultstring])
+          return false
+        end
+      end
+
+      self.sync_needed = false
+      return true
+    end
+  end
+end

data/app/models/gemgento/user.rb

@@ -0,0 +1,161 @@
+module Gemgento
+
+  # @author Gemgento LLC
+  class User < ActiveRecord::Base
+    devise :database_authenticatable, :registerable, :recoverable, :rememberable, :trackable, :validatable
+
+    belongs_to :user_group
+
+    has_many :addresses, as: :addressable, class_name: 'Gemgento::Address'
+    has_many :recurring_profiles, class_name: 'Gemgento::RecurringProfile'
+    has_many :saved_credit_cards, class_name: 'Gemgento::SavedCreditCard', dependent: :destroy
+    has_many :wishlist_items, class_name: 'Gemgento::WishlistItem'
+    has_many :orders, class_name: 'Gemgento::Order'
+    has_many :products, through: :wishlist_items, class_name: 'Gemgento::Product'
+
+    has_one :shopify_adapter, class_name: 'Adapter::ShopifyAdapter', as: :gemgento_model
+
+    has_and_belongs_to_many :stores, join_table: 'gemgento_stores_users', class_name: 'Store'
+
+    accepts_nested_attributes_for :orders
+
+    attr_accessor :subscribe
+
+    before_validation :manage_subscribe
+
+    before_create :magento_create, if: -> { magento_id.nil? }
+    after_save :magento_update, if: Proc.new { |u| u.sync_needed }
+
+    attr_accessor :sync_needed
+
+    default_scope -> { where(deleted_at: nil) }
+
+    validates :magento_id, uniqueness: true, allow_nil: true
+    validates :user_group, presence: true
+
+    def name
+      "#{self.first_name} #{self.last_name}".strip
+    end
+
+    def self.is_valid_login(email, password)
+
+      # If no customer with email is known, double check Magento
+      if !Gemgento::User.exists?(email: email) && customer = Gemgento::Magento::CustomerAdapter.find_by(email: email)
+        Gemgento::API::SOAP::Customer::Customer.fetch(customer[:customer_id])
+      end
+
+      user = User.find_by(email: email)
+
+      if user.nil? || !user.is_valid_password(password)
+        user = nil
+      end
+
+      user
+    end
+
+    def is_valid_password(password)
+      unless self.encrypted_password.blank?
+        return self.valid_password?(password)
+      else
+        if self.magento_password.blank? || !self.magento_password.include?(':') # if we don't have any passwords, get them from Magento
+          API::SOAP::Customer::Customer.fetch(self.magento_id)
+          self.reload
+        end
+
+        salt = self.magento_password.split(':')[1]
+        encrypted_password = Digest::MD5.hexdigest(salt + password)
+        encrypted_password += ':' + salt
+
+        if self.magento_password == encrypted_password
+          self.magento_password = nil
+          self.password = password
+          self.password_confirmation = password
+          self.sync_needed = false
+          self.save
+
+          return true
+        else
+          return false
+        end
+      end
+    end
+
+    def is_subscriber?
+      return !Subscriber.find_by(email: self.email).nil?
+    end
+
+    def mark_deleted
+      self.deleted_at = Time.now
+    end
+
+    def mark_deleted!
+      mark_deleted
+      self.save
+    end
+
+    def default_billing_address
+      self.addresses.find_by(is_billing: true)
+    end
+
+    def default_shipping_address
+      self.addresses.find_by(is_shipping: true)
+    end
+
+    def password_confirmation=(value)
+      @password_confirmation = value
+
+      # password changes must be pushed to magento, so that
+      # magento customer updates don't revert the password
+      self.sync_needed = true
+    end
+
+    def as_json(options = nil)
+      result = super
+      result['is_subscriber'] = self.is_subscriber?
+
+      return result
+    end
+
+    def subscribe
+      @subscribe ||= self.is_subscriber?
+    end
+
+    def manage_subscribe
+      self.subscribe = false if self.subscribe == 0 || self.subscribe == '0'
+      Subscriber.manage self, self.subscribe
+    end
+
+    private
+
+    # Create the user in Magento.  Called as a before_save callback, a failure to create new user in Magento will cancel
+    # the transaction and set the Magento response as base error on object.
+    #
+    # @return [Boolean]
+    def magento_create
+      response = API::SOAP::Customer::Customer.create(self, self.stores.first)
+
+      if response.success?
+        self.magento_id = response.body[:result]
+        self.created_in = self.stores.first.name
+        return true
+      else
+        self.errors.add(:base, response.body[:faultstring])
+        return false
+      end
+    end
+
+    def magento_update
+      self.stores.each do |store|
+        response = API::SOAP::Customer::Customer.update(self, store)
+
+        unless response.success?
+          self.errors.add(:base, response.body[:faultstring])
+          return false
+        end
+      end
+
+      return true
+    end
+
+  end
+end

data/app/models/gemgento/user_group.rb

@@ -0,0 +1,13 @@
+module Gemgento
+
+  # @author Gemgento LLC
+  class UserGroup < ActiveRecord::Base
+    def self.index
+      if UserGroup.all.size == 0
+        API::SOAP::Customer::Customer.fetch_all_user_groups
+      end
+
+      UserGroup.all
+    end
+  end
+end

data/app/models/gemgento/wishlist_item.rb

@@ -0,0 +1,11 @@
+module Gemgento
+
+  # @author Gemgento LLC
+  class WishlistItem < ActiveRecord::Base
+    belongs_to :product
+    belongs_to :user
+
+    validates :product, :user, presence: true
+    validates :product, uniqueness: { scope: :user }
+  end
+end

data/app/services/gemgento/magento_api.rb

@@ -0,0 +1,173 @@
+module Gemgento
+
+  # @author Gemgento LLC
+  class MagentoApi
+    # Log into the Magento API and set the session and client.
+    #
+    # @param force_new_session [Boolean]
+    # @return [Void]
+    def self.api_login(force_new_session = false)
+      @client = Savon.client(client_config)
+      @session = Session.get(@client, force_new_session)
+    end
+
+    # Define the client configuration.
+    #
+    # @return [Hash]
+    def self.client_config
+      config = {
+        wsdl: wsdl_url,
+        log: Config[:magento][:debug],
+        raise_errors: false,
+        open_timeout: 300,
+        read_timeout: 300
+      }
+
+      if !Config[:magento][:auth_username].blank? && !Config[:magento][:auth_password].blank?
+        config[:basic_auth] = [Config[:magento][:auth_username].to_s, Config[:magento][:auth_password].to_s]
+      end
+
+      return config
+    end
+
+    # URL of the WSDL definition.  Created from settings in /config/gemgento_config.yml.
+    #
+    # @return [String]
+    def self.wsdl_url
+      url = Gemgento::Config[:magento][:url].gsub(/\/$/, '') # ensure there is no trailing slash
+      url += "/index.php/api/v#{Gemgento::Config[:magento][:api_version]}_#{Gemgento::Config[:magento][:api_type]}/index/wsdl/1"
+
+      return url
+    end
+
+    # Make an API call to Magento and get the response
+    #
+    # @param [Symbol] function  The API call to make
+    # @param [Hash]   message   Call parameters (does not need session)
+    # @return [Hash]
+    def self.create_call(function, message = {})
+      api_login if !defined? @client
+
+      message[:sessionId] = @session
+      Rails.logger.debug "Making Call - #{function}"
+
+      magento_response = MagentoResponse.new
+
+      # don't save some messages because they are just too big!
+      if [:catalog_product_attribute_media_create].include? function
+        magento_response.request = {function: function, message: ''}
+      else
+        magento_response.request = {function: function, message: message}
+      end
+
+      response = @client.call(function, message: message)
+      log_call(function, message, response)
+
+      if response.success?
+        magento_response.success = true
+
+        if [:customer_customer_list, :sales_order_list, :catalog_product_list].include? function
+          magento_response.body = response.body[:"body_too_big"]
+          magento_response.body_overflow = response.body[:"#{function}_response"]
+        else
+          magento_response.body = response.body[:"#{function}_response"]
+        end
+
+        # only save successful responses if debugging is enabled
+        magento_response.save if Config[:magento][:debug]
+
+      else
+        magento_response.success = false
+        magento_response.body = response.body[:fault]
+        Rails.logger.error "Magento API Call failure - #{magento_response.body[:faultcode]} - #{magento_response.body[:faultstring]}"
+
+        if !magento_response.body[:faultcode].nil? && magento_response.body[:faultcode].to_i == 5
+          Rails.logger.debug '--- Attempting To Start New Session ---'
+          api_login(true)
+          create_call(function, message)
+        end
+
+        magento_response.save
+      end
+
+      magento_response.body = replace_empty_strings(magento_response.body)
+      magento_response.body_overflow = replace_empty_strings(magento_response.body_overflow) unless magento_response.body_overflow.nil?
+
+      return magento_response
+    end
+
+    def self.log_call(function, message, response)
+      logger = Logger.new('log/magento_api.log')
+
+      if response.success? && Gemgento::Config[:magento][:debug]
+        logger.debug "SUCCESS - Function: #{function} - Message: #{sanitize_message message} - Response: #{response.body}"
+      elsif !response.success?
+        logger.error "FAIL - Function: #{function} - Message: #{sanitize_message message} - Response: #{response.body}"
+      end
+    end
+
+    # Fill in missing empty strings.  Empty strings are represented by { :'@xsi:type' => 'xsd:string' }.
+    #
+    # @param subject [Hash]
+    # @return [Hash]
+    def self.replace_empty_strings(subject)
+      if subject == { :'@xsi:type' => 'xsd:string' }
+        return ''
+      elsif subject.is_a?(Array)
+        return subject.map{ |child| replace_empty_strings(child) }
+      elsif subject.is_a?(Hash)
+        return subject.each{ |key, value| subject[key] = replace_empty_strings(value) }
+      else
+        return subject
+      end
+    end
+
+    # Enforce string on subject.  If it's not a String, an empty string is returned.
+    #
+    # @param subject [*]
+    # @return [String]
+    def self.enforce_savon_string(subject)
+      if subject.is_a? String
+        subject
+      else
+        ''
+      end
+    end
+
+    # Enforce an array on the subject.  If the subject is not an array, it is inserted into a single element array.
+    #
+    # @param subject [*]
+    # @return [Array]
+    def self.enforce_savon_array(subject)
+      if subject.is_a? Array
+        subject
+      else
+        [subject]
+      end
+    end
+
+    def self.sanitize_message(message)
+      sanitized_keys = %w[cc_number cc_cid cc_exp_year cc_exp_month]
+
+      if message.is_a?(Hash)
+        message.each do |key, val|
+          next if val.nil?
+
+          if sanitized_keys.include? key.to_s
+            message[key] = '*' * val.size
+          else
+            message[key] = sanitize_message(val)
+          end
+        end
+
+      elsif message.is_a?(Array)
+        message.each_with_index do |val, i|
+          message[i] = sanitize_message(val)
+        end
+      end
+
+      return message
+    end
+
+  end
+end

data/app/services/gemgento/price.rb

@@ -0,0 +1,67 @@
+module Gemgento
+  class Price
+
+    attr_accessor :product, :store, :user_group, :quantity
+
+    # @param product [Gemgento::Product]
+    # @param user_group [Gemgento::UserGroup]
+    # @param store [Gemgento::Store]
+    # @param quantity [Float]
+    def initialize(product, user_group = nil, store = nil, quantity = 1.0)
+      @product = product
+      @store = store || Gemgento::Store.current
+      @user_group = user_group
+      @quantity = quantity
+    end
+
+    def calculate
+      return gift_price if product.magento_type == 'giftvoucher'
+
+      prices = []
+      prices << product.original_price(store)
+      prices << product.attribute_value('special_price', store).to_f if has_special?
+      prices << Gemgento::PriceRule.calculate_price(product, user_group, store)
+      prices << Gemgento::PriceTier.calculate_price(product, quantity, user_group, store)
+
+      return prices.min
+    end
+
+    # If product is a gift, determine gift value.
+    #
+    # @return [BigDecimal]
+    def gift_price
+      store = Gemgento::Store.current if store.nil?
+
+      case product.attribute_value('gift_price_type', store)
+        when 'Fixed number'
+          return product.attribute_value('gift_price', store).to_d
+        when 'Percent of Gift Card value'
+          return product.attribute_value('gift_value', store).to_d * (product.attribute_value('gift_price', store).to_d / 100.0)
+        else
+          return product.attribute_value('gift_value', store).to_d
+      end
+    end
+
+    # Determine if a product has a valid special price set.
+    #
+    # @return [Boolean]
+    def has_special?
+      special_price = product.attribute_value('special_price', store)
+      special_from_date = product.attribute_value('special_from_date', store)
+      special_to_date = product.attribute_value('special_to_date', store)
+
+      if special_price.nil? # no special price
+        return false
+      elsif special_from_date.nil? && special_to_date.nil?
+        return true
+      elsif special_from_date.nil? && !special_to_date.nil?
+        return Date.parse(special_to_date) >= Date.today
+      elsif special_to_date.nil? && !special_from_date.nil?
+        return Date.parse(special_from_date) <= Date.today
+      else
+        return Date.parse(special_from_date) <= Date.today && Date.parse(special_to_date) >= Date.today
+      end
+    end
+
+  end
+end