Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Introduce `Spree::ApiKey` model
Damian Legawieccf559e8df196
diff --git a/core/app/models/spree/api_key.rb b/core/app/models/spree/api_key.rbnew file mode 100644index 0000000000..676f378837--- /dev/null+++ b/core/app/models/spree/api_key.rb@@ -0,0 +1,44 @@+module Spree+ class ApiKey < Spree.base_class+ KEY_TYPES = %w[publishable secret].freeze+ PREFIXES = { 'publishable' => 'pk_', 'secret' => 'sk_' }.freeze+ TOKEN_LENGTH = 24++ belongs_to :store, class_name: 'Spree::Store'+ belongs_to :created_by, polymorphic: true, optional: true+ belongs_to :revoked_by, polymorphic: true, optional: true++ validates :name, presence: true+ validates :key_type, presence: true, inclusion: { in: KEY_TYPES }+ validates :token, presence: true, uniqueness: { scope: spree_base_uniqueness_scope }++ before_validation :generate_token, on: :create++ scope :active, -> { where(revoked_at: nil) }+ scope :revoked, -> { where.not(revoked_at: nil) }+ scope :publishable, -> { where(key_type: 'publishable') }+ scope :secret, -> { where(key_type: 'secret') }++ def publishable?+ key_type == 'publishable'+ end++ def secret?+ key_type == 'secret'+ end++ def active?+ revoked_at.nil?+ end++ def revoke!(user = nil)+ update!(revoked_at: Time.current, revoked_by: user)+ end++ private++ def generate_token+ self.token ||= "#{PREFIXES[key_type]}#{SecureRandom.base58(TOKEN_LENGTH)}"+ end+ end+enddiff --git a/core/db/migrate/20260123000000_create_spree_api_keys.rb b/core/db/migrate/20260123000000_create_spree_api_keys.rbnew file mode 100644index 0000000000..a4b77c4ddc--- /dev/null+++ b/core/db/migrate/20260123000000_create_spree_api_keys.rb@@ -0,0 +1,19 @@+class CreateSpreeApiKeys < ActiveRecord::Migration[7.2]+ def change+ create_table :spree_api_keys do |t|+ t.string :name, null: false+ t.string :key_type, null: false+ t.string :token, null: false+ t.references :store, null: false, index: true+ t.references :created_by, null: true, polymorphic: true, index: true+ t.datetime :last_used_at+ t.datetime :revoked_at+ t.references :revoked_by, null: true, polymorphic: true, index: true+ t.timestamps+ end++ add_index :spree_api_keys, :token, unique: true+ add_index :spree_api_keys, :key_type+ add_index :spree_api_keys, [:store_id, :key_type]+ end+enddiff --git a/core/lib/spree/testing_support/factories/api_key_factory.rb b/core/lib/spree/testing_support/factories/api_key_factory.rbnew file mode 100644index 0000000000..5136e6536a--- /dev/null+++ b/core/lib/spree/testing_support/factories/api_key_factory.rb@@ -0,0 +1,19 @@+FactoryBot.define do+ factory :api_key, class: Spree::ApiKey do+ name { FFaker::Lorem.word }+ key_type { 'publishable' }+ store++ trait :publishable do+ key_type { 'publishable' }+ end++ trait :secret do+ key_type { 'secret' }+ end++ trait :revoked do+ revoked_at { Time.current }+ end+ end+enddiff --git a/core/spec/models/spree/api_key_spec.rb b/core/spec/models/spree/api_key_spec.rbnew file mode 100644index 0000000000..e83107fb17--- /dev/null+++ b/core/spec/models/spree/api_key_spec.rb@@ -0,0 +1,167 @@+require 'spec_helper'++RSpec.describe Spree::ApiKey, type: :model do+ let(:store) { create(:store) }+ let(:api_key) { create(:api_key, store: store) }++ describe 'validations' do+ it 'is valid with valid attributes' do+ expect(api_key).to be_valid+ end++ it 'requires a name' do+ api_key.name = nil+ expect(api_key).not_to be_valid+ expect(api_key.errors[:name]).to be_present+ end++ it 'requires a key_type' do+ api_key.key_type = nil+ expect(api_key).not_to be_valid+ expect(api_key.errors[:key_type]).to be_present+ end++ it 'requires key_type to be publishable or secret' do+ api_key.key_type = 'invalid'+ expect(api_key).not_to be_valid+ expect(api_key.errors[:key_type]).to be_present+ end++ it 'requires a store' do+ api_key.store = nil+ expect(api_key).not_to be_valid+ end++ it 'requires unique token' do+ duplicate = build(:api_key, store: store, token: api_key.token)+ expect(duplicate).not_to be_valid+ expect(duplicate.errors[:token]).to be_present+ end+ end++ describe 'token generation' do+ it 'generates token on create' do+ new_key = build(:api_key, store: store, token: nil)+ new_key.save!+ expect(new_key.token).to be_present+ end++ it 'generates publishable key with pk_ prefix' do+ key = create(:api_key, :publishable, store: store)+ expect(key.token).to start_with('pk_')+ end++ it 'generates secret key with sk_ prefix' do+ key = create(:api_key, :secret, store: store)+ expect(key.token).to start_with('sk_')+ end++ it 'generates token of correct length' do+ expect(api_key.token.length).to eq(3 + Spree::ApiKey::TOKEN_LENGTH)+ end+ end++ describe 'scopes' do+ let!(:publishable_key) { create(:api_key, :publishable, store: store) }+ let!(:secret_key) { create(:api_key, :secret, store: store) }+ let!(:revoked_key) { create(:api_key, :revoked, store: store) }++ describe '.active' do+ it 'returns only non-revoked keys' do+ expect(described_class.active).to include(publishable_key, secret_key)+ expect(described_class.active).not_to include(revoked_key)+ end+ end++ describe '.revoked' do+ it 'returns only revoked keys' do+ expect(described_class.revoked).to include(revoked_key)+ expect(described_class.revoked).not_to include(publishable_key, secret_key)+ end+ end++ describe '.publishable' do+ it 'returns only publishable keys' do+ expect(described_class.publishable).to include(publishable_key)+ expect(described_class.publishable).not_to include(secret_key)+ end+ end++ describe '.secret' do+ it 'returns only secret keys' do+ expect(described_class.secret).to include(secret_key)+ expect(described_class.secret).not_to include(publishable_key)+ end+ end+ end++ describe '#publishable?' do+ it 'returns true for publishable key' do+ key = build(:api_key, :publishable)+ expect(key.publishable?).to be true+ end++ it 'returns false for secret key' do+ key = build(:api_key, :secret)+ expect(key.publishable?).to be false+ end+ end++ describe '#secret?' do+ it 'returns true for secret key' do+ key = build(:api_key, :secret)+ expect(key.secret?).to be true+ end++ it 'returns false for publishable key' do+ key = build(:api_key, :publishable)+ expect(key.secret?).to be false+ end+ end++ describe '#active?' do+ it 'returns true for non-revoked key' do+ expect(api_key.active?).to be true+ end++ it 'returns false for revoked key' do+ api_key.revoke!+ expect(api_key.active?).to be false+ end+ end++ describe '#revoke!' do+ it 'sets revoked_at timestamp' do+ expect { api_key.revoke! }.to change { api_key.revoked_at }.from(nil)+ end++ it 'sets revoked_by when user provided' do+ user = create(:user)+ api_key.revoke!(user)+ expect(api_key.revoked_by).to eq(user)+ end++ it 'marks key as inactive' do+ api_key.revoke!+ expect(api_key.active?).to be false+ end+ end++ describe 'associations' do+ it 'belongs to store' do+ expect(api_key.store).to eq(store)+ end++ it 'can have created_by' do+ user = create(:user)+ key = create(:api_key, store: store, created_by: user)+ expect(key.created_by).to eq(user)+ end++ it 'can have revoked_by' do+ user = create(:user)+ api_key.revoke!(user)+ expect(api_key.revoked_by).to eq(user)+ end+ end+end