spree_core 4.3.0.rc1 → 4.4.0.rc1

data/app/models/concerns/spree/user_roles.rb

@@ -0,0 +1,43 @@
+module Spree
+  module UserRoles
+    extend ActiveSupport::Concern
+
+    included do
+      has_many :role_users, class_name: 'Spree::RoleUser', foreign_key: :user_id, dependent: :destroy
+      has_many :spree_roles, through: :role_users, class_name: 'Spree::Role', source: :role
+
+      scope :spree_admin, -> { joins(:spree_roles).where(Spree::Role.table_name => { name: 'admin' }) }
+
+      # has_spree_role? simply needs to return true or false whether a user has a role or not.
+      def has_spree_role?(role_name)
+        spree_roles.exists?(name: role_name)
+      end
+
+      def self.admin
+        ActiveSupport::Deprecation.warn('`User#admin` is deprecated and will be removed in Spree 5. Please use `User#spree_admin`')
+
+        spree_admin
+      end
+
+      def self.admin_created?
+        ActiveSupport::Deprecation.warn('`User#admin_created?` is deprecated and will be removed in Spree 5. Please use `User#spree_admin_created?`')
+
+        spree_admin_created?
+      end
+
+      def admin?
+        ActiveSupport::Deprecation.warn('`User#admin?` is deprecated and will be removed in Spree 5. Please use `User#spree_admin?`')
+
+        spree_admin?
+      end
+
+      def self.spree_admin_created?
+        spree_admin.exists?
+      end
+
+      def spree_admin?
+        has_spree_role?('admin')
+      end
+    end
+  end
+end

data/app/models/spree/ability.rb

@@ -1,8 +1,9 @@
-# Implementation class for Cancan gem.  Instead of overriding this class, consider adding new permissions
+# Implementation class for Cancan gem. Instead of overriding this class, consider adding new permissions
 # using the special +register_ability+ method which allows extensions to add their own abilities.
 #
-# See http://github.com/ryanb/cancan for more details on cancan.
+# See https://github.com/CanCanCommunity/cancancan for more details.
 require 'cancan'
+
 module Spree
   class Ability
     include CanCan::Ability
@@ -27,7 +28,7 @@ module Spree
 
       user ||= Spree.user_class.new
 
-      if user.respond_to?(:has_spree_role?) && user.has_spree_role?('admin')
+      if user.persisted? && user.try(:spree_admin?)
         apply_admin_permissions(user)
       else
         apply_user_permissions(user)
@@ -85,6 +86,13 @@ module Spree
       can :read, ::Spree::Taxonomy
       can :read, ::Spree::Variant
       can :read, ::Spree::Zone
+      can :manage, ::Spree::Wishlist, user_id: user.id
+      can :show, ::Spree::Wishlist do |wishlist|
+        wishlist.user == user || wishlist.is_private == false
+      end
+      can [:create, :update, :destroy], ::Spree::WishedItem do |wished_item|
+        wished_item.wishlist.user == user
+      end
     end
 
     def protect_admin_role

data/app/models/spree/address.rb

@@ -2,6 +2,8 @@ module Spree
   class Address < Spree::Base
     require 'validates_zipcode'
 
+    include Metadata
+
     if Rails::VERSION::STRING >= '6.1'
       serialize :preferences, Hash, default: {}
     end
@@ -23,7 +25,7 @@ module Spree
     # we're not freezing this on purpose so developers can extend and manage
     # those attributes depending of the logic of their applications
     ADDRESS_FIELDS = %w(firstname lastname company address1 address2 city state zipcode country phone)
-    EXCLUDED_KEYS_FOR_COMPARISION = %w(id updated_at created_at deleted_at label user_id)
+    EXCLUDED_KEYS_FOR_COMPARISON = %w(id updated_at created_at deleted_at label user_id)
 
     scope :not_deleted, -> { where(deleted_at: nil) }
 
@@ -117,7 +119,7 @@ module Spree
     end
 
     def value_attributes
-      attributes.except(*EXCLUDED_KEYS_FOR_COMPARISION)
+      attributes.except(*EXCLUDED_KEYS_FOR_COMPARISON)
     end
 
     def empty?

data/app/models/spree/adjustment.rb

@@ -42,6 +42,7 @@ module Spree
       end
     end
 
+    # FIXME: we should check if we also need to fire this action after update
     after_create :update_adjustable_adjustment_total
     after_destroy :update_adjustable_adjustment_total
 

data/app/models/spree/app_configuration.rb

@@ -22,49 +22,46 @@ module Spree
     # Alphabetized to more easily lookup particular preferences
     preference :address_requires_state, :boolean, default: true # should state/state_name be required
     preference :address_requires_phone, :boolean, default: true # Determines whether we require phone in address
-    preference :admin_interface_logo, :string, default: 'admin/logo.png'
-    preference :admin_path, :string, default: '/admin'
-    preference :admin_products_per_page, :integer, default: Kaminari.config.default_per_page
-    preference :admin_orders_per_page, :integer, default: Kaminari.config.default_per_page
-    preference :admin_properties_per_page, :integer, default: Kaminari.config.default_per_page
-    preference :admin_promotions_per_page, :integer, default: Kaminari.config.default_per_page
-    preference :admin_customer_returns_per_page, :integer, default: Kaminari.config.default_per_page
-    preference :admin_users_per_page, :integer, default: Kaminari.config.default_per_page
-    preference :admin_show_version, :boolean, default: true
+    preference :admin_path, :string, deprecated: true
+    preference :admin_products_per_page, :integer, deprecated: true
+    preference :admin_orders_per_page, :integer, deprecated: true
+    preference :admin_properties_per_page, :integer, deprecated: true
+    preference :admin_promotions_per_page, :integer, deprecated: true
+    preference :admin_customer_returns_per_page, :integer, deprecated: true
+    preference :admin_users_per_page, :integer, deprecated: true
+    preference :admin_show_version, :boolean, deprecated: true
     preference :allow_checkout_on_gateway_error, :boolean, default: false
     preference :allow_guest_checkout, :boolean, default: true
     preference :alternative_shipping_phone, :boolean, default: false # Request extra phone for ship addr
     preference :always_include_confirm_step, :boolean, default: false # Ensures confirmation step is always in checkout_progress bar, but does not force a confirm step if your payment methods do not support it.
-    preference :always_put_site_name_in_title, :boolean, default: true
-    preference :title_site_name_separator, :string, default: '-' # When always_put_site_name_in_title is true, insert a separator character before the site name in the title
+    preference :always_put_site_name_in_title, :boolean, deprecated: true
+    preference :title_site_name_separator, :string, deprecated: true
     preference :auto_capture, :boolean, default: false # automatically capture the credit card (as opposed to just authorize and capture later)
     preference :auto_capture_on_dispatch, :boolean, default: false # Captures payment for each shipment in Shipment#after_ship callback, and makes Shipment.ready when payment authorized.
     preference :binary_inventory_cache, :boolean, default: false # only invalidate product cache when a stock item changes whether it is in_stock
-    preference :checkout_zone, :string, default: nil # replace with the name of a zone if you would like to limit the countries
+    preference :checkout_zone, :string, default: nil, deprecated: true # replace with the name of a zone if you would like to limit the countries
     preference :company, :boolean, default: false # Request company field for billing and shipping addr
-    preference :currency, :string, default: 'USD'
-    preference :default_country_id, :integer
+    preference :currency, :string, default: 'USD', deprecated: true
+    preference :default_country_id, :integer, deprecated: true
     preference :disable_sku_validation, :boolean, default: false # when turned off disables the built-in SKU uniqueness validation
     preference :disable_store_presence_validation, :boolean, default: false # when turned off disables Store presence validation for Products and Payment Methods
     preference :expedited_exchanges, :boolean, default: false # NOTE this requires payment profiles to be supported on your gateway of choice as well as a delayed job handler to be configured with activejob. kicks off an exchange shipment upon return authorization save. charge customer if they do not return items within timely manner.
     preference :expedited_exchanges_days_window, :integer, default: 14 # the amount of days the customer has to return their item after the expedited exchange is shipped in order to avoid being charged
-    preference :layout, :string, default: 'spree/layouts/spree_application'
-    preference :logo, :string, default: 'logo/spree_50.png'
-    preference :mailer_logo, :string, default: 'logo/spree_50.png'
-    preference :max_level_in_taxons_menu, :integer, default: 1 # maximum nesting level in taxons menu
+    preference :layout, :string, deprecated: 'Please use Spree::Frontend::Config[:layout] instead'
+    preference :logo, :string, deprecated: true
+    preference :mailer_logo, :string, deprecated: true
+    preference :max_level_in_taxons_menu, :integer, deprecated: true
     preference :products_per_page, :integer, default: 12
-    preference :product_wysiwyg_editor_enabled, :boolean, default: true
     preference :require_master_price, :boolean, default: true
     preference :restock_inventory, :boolean, default: true # Determines if a return item is restocked automatically once it has been received
     preference :return_eligibility_number_of_days, :integer, default: 365
     preference :send_core_emails, :boolean, default: true # Default mail headers settings
-    preference :shipping_instructions, :boolean, default: false # Request instructions/info for shipping
-    preference :show_only_complete_orders_by_default, :boolean, default: true
+    preference :shipping_instructions, :boolean, deprecated: true
+    preference :show_only_complete_orders_by_default, :boolean, deprecated: true
     preference :show_variant_full_price, :boolean, default: false # Displays variant full price or difference with product price. Default false to be compatible with older behavior
     preference :show_products_without_price, :boolean, default: false
-    preference :show_raw_product_description, :boolean, default: false
+    preference :show_raw_product_description, :boolean, deprecated: true
     preference :tax_using_ship_address, :boolean, default: true
-    preference :taxon_wysiwyg_editor_enabled, :boolean, default: true
     preference :track_inventory_levels, :boolean, default: true # Determines whether to track on_hand values for variants / products.
 
     # Store credits configurations
@@ -72,7 +69,7 @@ module Spree
     preference :credit_to_new_allocation, :boolean, default: false
 
     # Multi store configurations
-    preference :show_store_selector, :boolean, default: false
+    preference :show_store_selector, :boolean, deprecated: true
 
     # searcher_class allows spree extension writers to provide their own Search class
     def searcher_class

data/app/models/spree/asset.rb

@@ -1,6 +1,7 @@
 module Spree
   class Asset < Spree::Base
     include Support::ActiveStorage
+    include Metadata
 
     belongs_to :viewable, polymorphic: true, touch: true
     acts_as_list scope: [:viewable_id, :viewable_type]

data/app/models/spree/base.rb

@@ -36,6 +36,10 @@ class Spree::Base < ApplicationRecord
     where(nil)
   end
 
+  def self.spree_base_uniqueness_scope
+    ApplicationRecord.try(:spree_base_uniqueness_scope) || []
+  end
+
   # FIXME: https://github.com/rails/rails/issues/40943
   def self.has_many_inversing
     false
@@ -45,6 +49,16 @@ class Spree::Base < ApplicationRecord
     column_names.reject { |c| c.match(/_id$|id|preferences|(.*)password|(.*)token|(.*)api_key/) }
   end
 
+  def self.json_api_permitted_attributes
+    skipped_attributes = %w[id]
+
+    if included_modules.include?(CollectiveIdea::Acts::NestedSet::Model)
+      skipped_attributes.push('lft', 'rgt', 'depth')
+    end
+
+    column_names.reject { |c| skipped_attributes.include?(c.to_s) }
+  end
+
   def self.json_api_type
     to_s.demodulize.underscore
   end

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

@@ -3,7 +3,7 @@ require_dependency 'spree/calculator'
 module Spree
   class Calculator::FlatRate < Calculator
     preference :amount, :decimal, default: 0
-    preference :currency, :string, default: -> { Spree::Config[:currency] }
+    preference :currency, :string, default: -> { Spree::Store.default.default_currency }
 
     def self.description
       Spree.t(:flat_rate_per_order)

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

@@ -5,7 +5,7 @@ module Spree
     preference :first_item,      :decimal, default: 0.0
     preference :additional_item, :decimal, default: 0.0
     preference :max_items,       :integer, default: 0
-    preference :currency,        :string,  default: -> { Spree::Config[:currency] }
+    preference :currency,        :string,  default: -> { Spree::Store.default.default_currency }
 
     def self.description
       Spree.t(:flexible_rate)

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

@@ -5,7 +5,7 @@ module Spree
     preference :minimal_amount, :decimal, default: 0
     preference :normal_amount, :decimal, default: 0
     preference :discount_amount, :decimal, default: 0
-    preference :currency, :string, default: -> { Spree::Config[:currency] }
+    preference :currency, :string, default: -> { Spree::Store.default.default_currency }
 
     def self.description
       Spree.t(:price_sack)

data/app/models/spree/calculator/shipping/digital_delivery.rb

@@ -0,0 +1,22 @@
+require_dependency 'spree/shipping_calculator'
+
+module Spree
+  module Calculator::Shipping
+    class DigitalDelivery < ShippingCalculator
+      preference :amount, :decimal, default: 0
+      preference :currency, :string, default: -> { Spree::Store.default.default_currency }
+
+      def self.description
+        Spree.t('digital.digital_delivery')
+      end
+
+      def compute_package(_package = nil)
+        preferred_amount
+      end
+
+      def available?(package)
+        package.contents.all? { |content| content.variant.digital? }
+      end
+    end
+  end
+end

data/app/models/spree/calculator/shipping/flat_rate.rb

@@ -4,7 +4,7 @@ module Spree
   module Calculator::Shipping
     class FlatRate < ShippingCalculator
       preference :amount, :decimal, default: 0
-      preference :currency, :string, default: -> { Spree::Config[:currency] }
+      preference :currency, :string, default: -> { Spree::Store.default.default_currency }
 
       def self.description
         Spree.t(:shipping_flat_rate_per_order)

data/app/models/spree/calculator/shipping/flexi_rate.rb

@@ -6,7 +6,7 @@ module Spree
       preference :first_item,      :decimal, default: 0.0
       preference :additional_item, :decimal, default: 0.0
       preference :max_items,       :integer, default: 0
-      preference :currency,        :string,  default: -> { Spree::Config[:currency] }
+      preference :currency,        :string,  default: -> { Spree::Store.default.default_currency }
 
       def self.description
         Spree.t(:shipping_flexible_rate)

data/app/models/spree/calculator/shipping/per_item.rb

@@ -4,7 +4,7 @@ module Spree
   module Calculator::Shipping
     class PerItem < ShippingCalculator
       preference :amount, :decimal, default: 0
-      preference :currency, :string, default: -> { Spree::Config[:currency] }
+      preference :currency, :string, default: -> { Spree::Store.default.default_currency }
 
       def self.description
         Spree.t(:shipping_flat_rate_per_item)

data/app/models/spree/calculator/shipping/price_sack.rb

@@ -6,7 +6,7 @@ module Spree
       preference :minimal_amount, :decimal, default: 0
       preference :normal_amount, :decimal, default: 0
       preference :discount_amount, :decimal, default: 0
-      preference :currency, :string, default: -> { Spree::Config[:currency] }
+      preference :currency, :string, default: -> { Spree::Store.default.default_currency }
 
       def self.description
         Spree.t(:shipping_price_sack)

data/app/models/spree/calculator.rb

@@ -4,7 +4,7 @@ module Spree
 
     belongs_to :calculable, polymorphic: true, optional: true
 
-    # This method calls a compute_<computable> method. must be overriden in concrete calculator.
+    # This method calls a compute_<computable> method. must be overridden in concrete calculator.
     #
     # It should return amount computed based on #calculable and the computable parameter
     def compute(computable)

data/app/models/spree/cms/sections/featured_article.rb

@@ -1,6 +1,5 @@
 module Spree::Cms::Sections
   class FeaturedArticle < Spree::CmsSection
-    before_save :reset_link_attributes
     after_initialize :default_values
 
     store :content, accessors: [:title, :subtitle, :button_text, :rte_content], coder: JSON
@@ -14,12 +13,6 @@ module Spree::Cms::Sections
 
     private
 
-    def reset_link_attributes
-      if linked_resource_type_changed?
-        self.linked_resource_id = nil
-      end
-    end
-
     def default_values
       self.gutters ||= 'No Gutters'
       self.fit ||= 'Screen'

data/app/models/spree/cms/sections/hero_image.rb

@@ -1,6 +1,5 @@
 module Spree::Cms::Sections
   class HeroImage < Spree::CmsSection
-    before_save :reset_link_attributes
     after_initialize :default_values
 
     store :content, accessors: [:title, :button_text], coder: JSON
@@ -30,14 +29,6 @@ module Spree::Cms::Sections
 
     private
 
-    def reset_link_attributes
-      if linked_resource_type_changed?
-        return if linked_resource_id_was.nil?
-
-        self.linked_resource_id = nil
-      end
-    end
-
     def default_values
       self.gutters ||= 'No Gutters'
       self.fit ||= 'Screen'

data/app/models/spree/cms/sections/image_gallery.rb

@@ -1,7 +1,7 @@
 module Spree::Cms::Sections
   class ImageGallery < Spree::CmsSection
     after_initialize :default_values
-    before_save :reset_link_attributes
+    validate :reset_multiple_link_attributes
 
     LINKED_RESOURCE_TYPE = if Rails::VERSION::STRING < '6.0'
                              ['Spree::Taxon'].freeze
@@ -70,7 +70,7 @@ module Spree::Cms::Sections
 
     private
 
-    def reset_link_attributes
+    def reset_multiple_link_attributes
       return if Rails::VERSION::STRING < '6.0'
 
       if link_type_one_changed?

data/app/models/spree/cms/sections/side_by_side_images.rb

@@ -1,7 +1,7 @@
 module Spree::Cms::Sections
   class SideBySideImages < Spree::CmsSection
     after_initialize :default_values
-    before_save :reset_link_attributes
+    validate :reset_multiple_link_attributes
 
     LINKED_RESOURCE_TYPE = if Rails::VERSION::STRING < '6.0'
                              ['Spree::Taxon'].freeze
@@ -48,7 +48,7 @@ module Spree::Cms::Sections
 
     private
 
-    def reset_link_attributes
+    def reset_multiple_link_attributes
       return if Rails::VERSION::STRING < '6.0'
 
       if link_type_one_changed?

data/app/models/spree/cms_page.rb

@@ -16,7 +16,7 @@ module Spree
 
     before_validation :handle_slug
 
-    validates :title, :store, :locale, presence: true
+    validates :title, :store, :locale, :type, presence: true
     validates :slug, uniqueness: { scope: :store_id, allow_nil: true, case_sensitive: true }
     validates :locale, uniqueness: { scope: [:store, :type] }, if: :homepage?
 
@@ -28,7 +28,7 @@ module Spree
     scope :standard, -> { where(type: 'Spree::Cms::Pages::StandardPage') }
     scope :feature, -> { where(type: 'Spree::Cms::Pages::FeaturePage') }
 
-    self.whitelisted_ransackable_attributes = %w[title type locale store_id]
+    self.whitelisted_ransackable_attributes = %w[title type locale]
 
     def seo_title
       if meta_title.present?
@@ -38,7 +38,7 @@ module Spree
       end
     end
 
-    # Overide this if your page type uses cms_sections
+    # Override this if your page type uses cms_sections
     def sections?
       false
     end

data/app/models/spree/cms_section.rb

@@ -5,6 +5,8 @@ module Spree
     acts_as_list scope: :cms_page
     belongs_to :cms_page, touch: true
 
+    validate :reset_link_attributes
+
     IMAGE_COUNT = ['one', 'two', 'three']
     IMAGE_TYPES = ['image/png', 'image/jpg', 'image/jpeg', 'image/gif'].freeze
     IMAGE_SIZE = ['sm', 'md', 'lg', 'xl']
@@ -25,7 +27,7 @@ module Spree
 
     default_scope { order(position: :asc) }
 
-    validates :name, :cms_page, presence: true
+    validates :name, :cms_page, :type, presence: true
 
     validates :image_one, :image_two, :image_three, content_type: IMAGE_TYPES
 
@@ -53,5 +55,15 @@ module Spree
     def fullscreen?
       fit == 'Screen'
     end
+
+    private
+
+    def reset_link_attributes
+      if linked_resource_type_changed?
+        return if linked_resource_id_was.nil?
+
+        self.linked_resource_id = nil
+      end
+    end
   end
 end

data/app/models/spree/country.rb

@@ -2,7 +2,7 @@ module Spree
   class Country < Spree::Base
     # we need to have this callback before any dependent: :destroy associations
     # https://github.com/rails/rails/issues/3458
-    before_destroy :ensure_not_default
+    # before_destroy :ensure_not_default
 
     has_many :addresses, dependent: :restrict_with_error
     has_many :states,
@@ -16,7 +16,7 @@ module Spree
              foreign_key: :zoneable_id
     has_many :zones, through: :zone_members, class_name: 'Spree::Zone'
 
-    validates :name, :iso_name, :iso, :iso3, presence: true, uniqueness: { case_sensitive: false }
+    validates :name, :iso_name, :iso, :iso3, presence: true, uniqueness: { case_sensitive: false, scope: spree_base_uniqueness_scope }
 
     def self.default(store = nil)
       ActiveSupport::Deprecation.warn(<<-DEPRECATION, caller)
@@ -49,6 +49,8 @@ module Spree
     private
 
     def ensure_not_default
+      ActiveSupport::Deprecation.warn('Country#ensure_not_default is deprecated and will be removed in Spree v5')
+
       if id.eql?(Spree::Config[:default_country_id])
         errors.add(:base, Spree.t(:default_country_cannot_be_deleted))
         throw(:abort)

data/app/models/spree/credit_card.rb

@@ -1,6 +1,7 @@
 module Spree
   class CreditCard < Spree::Base
     include ActiveMerchant::Billing::CreditCardMethods
+    include Metadata
 
     acts_as_paranoid
 
@@ -171,6 +172,15 @@ module Spree
       )
     end
 
+    def self.json_api_permitted_attributes
+      [
+        'number', 'month', 'year', 'expiry', 'verification_value', 'first_name', 'last_name', 
+        'cc_type', 'gateway_customer_profile_id', 'gateway_payment_profile_id', 'last_digits', 
+        'name', 'encrypted_data', 'address_id', 'created_at', 'updated_at', 'user_id', 
+        'payment_method_id', 'default', 'deleted_at'
+      ]
+    end
+
     private
 
     def require_card_numbers?

data/app/models/spree/customer_return.rb

@@ -1,6 +1,9 @@
 module Spree
   class CustomerReturn < Spree::Base
     include Spree::Core::NumberGenerator.new(prefix: 'CR', length: 9)
+    include NumberIdentifier
+    include Metadata
+
     belongs_to :stock_location
     belongs_to :store, class_name: 'Spree::Store', inverse_of: :customer_returns
 
@@ -11,7 +14,6 @@ module Spree
     after_create :process_return!
 
     validates :store, presence: true
-    validates :number, uniqueness: { case_sensitive: true }
     validates :return_items, :stock_location, presence: true
     validate :must_have_return_authorization, on: :create
     validate :return_items_belong_to_same_order

data/app/models/spree/digital.rb

@@ -0,0 +1,15 @@
+module Spree
+  class Digital < Spree::Base
+    belongs_to :variant
+    has_many :digital_links, dependent: :destroy
+
+    if Spree.private_storage_service_name
+      has_one_attached :attachment, service: Spree.private_storage_service_name
+    else
+      has_one_attached :attachment
+    end
+
+    validates :attachment, attached: true
+    validates :variant, presence: true
+  end
+end

data/app/models/spree/digital_link.rb

@@ -0,0 +1,50 @@
+module Spree
+  class DigitalLink < Spree::Base
+    has_secure_token
+
+    belongs_to :digital
+    belongs_to :line_item
+
+    before_validation :set_defaults, on: :create
+    validates :digital, :line_item, presence: true
+    validates :access_counter, numericality: { greater_than_or_equal_to: 0 }
+
+    def authorizable?
+      !(expired? || access_limit_exceeded?)
+    end
+
+    def expired?
+      if line_item.order.store.limit_digital_download_days
+        created_at <= line_item.order.store.digital_asset_authorized_days.day.ago
+      else
+        false
+      end
+    end
+
+    def access_limit_exceeded?
+      if line_item.order.store.limit_digital_download_count
+        access_counter >= line_item.order.store.digital_asset_authorized_clicks
+      else
+        false
+      end
+    end
+
+    # This method should be called when a download is initiated.
+    # It returns +true+ or +false+ depending on whether the authorization is granted.
+    def authorize!
+      authorizable? && increment!(:access_counter, touch: true) ? true : false
+    end
+
+    def reset!
+      self.access_counter = 0
+      self.created_at = Time.current
+      save!
+    end
+
+    private
+
+    def set_defaults
+      self.access_counter ||= 0
+    end
+  end
+end

data/app/models/spree/gateway/bogus.rb

@@ -9,14 +9,12 @@ module Spree
 
     attr_accessor :test
 
+    preference :dummy_key, :string, default: 'PUBLICKEY123'
+
     def provider_class
       self.class
     end
 
-    def preferences
-      {}
-    end
-
     def create_profile(payment)
       return if payment.source.has_payment_profile?
 
@@ -73,6 +71,10 @@ module Spree
       true
     end
 
+    def payment_source_class
+      CreditCard
+    end
+
     def actions
       %w(capture void credit)
     end
@@ -88,5 +90,9 @@ module Spree
       end
       random
     end
+
+    def public_preference_keys
+      [:dummy_key]
+    end
   end
 end